Skip to content

document configurable avatar behaviour #803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MorrisJobke merged 2 commits into from
Jul 11, 2018
Merged

document configurable avatar behaviour #803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
234f556
update outdated info
blizzz Jul 4, 2018
0bef515
add information about configurable LDAP Avatar behaviour
blizzz Jul 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions admin_manual/configuration_user/user_auth_ldap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ create separate Nextcloud user accounts for them. You will manage their Nextclou
group memberships, quotas, and sharing permissions just like any other Nextcloud
user.

.. note:: The PHP LDAP module is required; this is supplied by ``php5-ldap`` on
Debian/Ubuntu, and ``php-ldap`` on CentOS/Red Hat/Fedora. PHP 5.6+ is
required in Nextcloud.
.. note:: The PHP LDAP module is required; this is supplied by ``php-ldap`` on
most distributions.

The LDAP application supports:

Expand All @@ -28,9 +27,6 @@ The LDAP application supports:
supported)
* Optional: Allow users to change their LDAP password from Nextcloud

.. warning:: The LDAP app is not compatible with the ``User backend using remote
HTTP servers`` app. You cannot use both of them at the same time.

.. note:: A non-blocking or correctly configured SELinux setup is needed
for the LDAP backend to work. Please refer to the :ref:`selinux-config-label`.

Expand Down Expand Up @@ -584,6 +580,31 @@ Nextcloud avatar replaces it.
Photos served from LDAP are automatically cropped and resized in Nextcloud. This
affects only the presentation, and the original image is not changed.

Use a specific attribute or turn of loading of images
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

It is possible to turn off the avatar integration or specify a single,
different attribute to read the image from. It is expected to contain image
data just like *jpegPhoto* or *thumbnailPhoto* do.

The behaviour can be changed using the occ command line tool only. Essentially
those options are available:

* The default behaviour as described above should be used

``occ ldap:set-config "s01" "ldapUserAvatarRule" "default"``

* User images shall not be fetched from LDAP

``occ ldap:set-config "s01" "ldapUserAvatarRule" "none"``

* The image should be read from the attribute "selfiePhoto"

``occ ldap:set-config "s01" "ldapUserAvatarRule" "data:selfiePhoto"``

The "s01" refers to the configuration ID as can be retrieved per
``occ ldap:show-config``.

Troubleshooting, tips and tricks
--------------------------------

Expand Down
2 changes: 2 additions & 0 deletions admin_manual/configuration_user/user_auth_ldap_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,8 @@ Configuration keys
+-------------------------------+------+----------+-----------------------------------------------------------------------------------------------------------------------+
| ldapUserDisplayName2 | rw | no | Additional attribute, if set show on brackets next to the main attribute |
+-------------------------------+------+----------+-----------------------------------------------------------------------------------------------------------------------+
| ldapUserAvatarRule | rw | no | Specify the avatar integration behavior, possible values: "default", "none", "data:$ATTRIBUTENAME" |
+-------------------------------+------+----------+-----------------------------------------------------------------------------------------------------------------------+
| ldapGidNumber | rw | no | group ID attribute, needed for primary groups on OpenLDAP (and compatible) |
+-------------------------------+------+----------+-----------------------------------------------------------------------------------------------------------------------+
| ldapUserFilterObjectclass | rw | no | set by the Settings Wizard (web UI) |
Expand Down