Document how setting LDAP properties disables web UI

If the full name, email address, or ssh username is set from LDAP,
the web UI disables these fields and does not permit an end-user
to modify them.  This helps to ensure that the user information we
pick up from the organizational directory always matches the data
stored in that directory.

Signed-off-by: Shawn O. Pearce <sop@google.com>
This commit is contained in:
Shawn O. Pearce 2009-08-20 08:56:23 -07:00
parent 20e21fbfc7
commit 3ca1dcf387

View File

@ -530,6 +530,9 @@ contains the initial value for the user's full name field in Gerrit.
Typically this is the `displayName` property in LDAP, but could
also be `legalName` or `cn`.
+
If set, users will be unable to modify their full name field, as
Gerrit will populate it only from the LDAP data.
+
Default is `displayName`, a common value for most servers.
[[ldap.accountEmailAddress]]ldap.accountEmailAddress::
@ -538,6 +541,10 @@ _(Optional)_ Name of an attribute on the user account object which
contains the user's Internet email address, as defined by this
LDAP server.
+
If set, the preferred email address will be prefilled from LDAP,
but users may still be able to register additional email address,
and select a different preferred email address.
+
Default is `mail`, a common value for most servers.
[[ldap.accountSshUserName]]ldap.accountSshUserName::
@ -549,6 +556,9 @@ also be `cn`. Administrators should prefer to match the attribute
corresponding to the user's workstation username, as this is what
SSH clients will default to.
+
If set, users will be unable to modify their SSH username field, as
Gerrit will populate it only from the LDAP data.
+
Default is `uid`, a common value for most servers.
[[ldap.groupBase]]ldap.groupBase::