diff options
| author | Sergio Benitez <sbenitez@mit.edu> | 2015-08-12 17:08:16 -0700 |
|---|---|---|
| committer | Sergio Benitez <sbenitez@mit.edu> | 2015-08-12 17:08:16 -0700 |
| commit | f8a4ab25fda9731803e787160f54d767d1b57eef (patch) | |
| tree | a3f7ca0546053fd2b2e60b683d565de48bba500a | |
| parent | 7d84d4a8f0cb30df04241f528ed74672a485274a (diff) | |
| download | gitea-f8a4ab25fda9731803e787160f54d767d1b57eef.tar.gz gitea-f8a4ab25fda9731803e787160f54d767d1b57eef.zip | |
Updated the LDAP module readme.
| -rw-r--r-- | modules/auth/ldap/README.md | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/modules/auth/ldap/README.md b/modules/auth/ldap/README.md index 5d515848e2..208f148e2f 100644 --- a/modules/auth/ldap/README.md +++ b/modules/auth/ldap/README.md @@ -16,49 +16,49 @@ retrieved and passed to the Gogs login infrastructure. To use this module, add an LDAP authentication source via the Authentications section in the admin panel. The fields should be set as follows: -Authorization Name (required) - A name to assign to the new method of authorization. +* Authorization Name **(required)** + * A name to assign to the new method of authorization. -Host (required) - The address where the LDAP server can be reached. - Example: mydomain.com +* Host **(required)** + * The address where the LDAP server can be reached. + * Example: mydomain.com -Port (required) - The port to use when connecting to the server. - Example: 636 +* Port **(required)** + * The port to use when connecting to the server. + * Example: 636 -Enable TLS Encryption (optional) - Whether to use TLS when connecting to the LDAP server. +* Enable TLS Encryption (optional) + * Whether to use TLS when connecting to the LDAP server. -Bind DN (optional) - The DN to bind to the LDAP server with when searching for the user. +* Bind DN (optional) + * The DN to bind to the LDAP server with when searching for the user. This may be left blank to perform an anonymous search. - Example: cn=Search,dc=mydomain,dc=com + * Example: cn=Search,dc=mydomain,dc=com -Bind Password (optional) - The password for the Bind DN specified above, if any. +* Bind Password (optional) + * The password for the Bind DN specified above, if any. -User Search Base (required) - The LDAP base at which user accounts will be searched for. - Example: ou=Users,dc=mydomain,dc=com +* User Search Base **(required)** + * The LDAP base at which user accounts will be searched for. + * Example: ou=Users,dc=mydomain,dc=com -User Filter (required) - An LDAP filter declaring how to find the user record that is attempting +* User Filter **(required)** + * An LDAP filter declaring how to find the user record that is attempting to authenticate. The '%s' matching parameter will be substituted with the user's username. - Example: (&(objectClass=posixAccount)(uid=%s)) + * Example: (&(objectClass=posixAccount)(uid=%s)) -First name attribute (optional) - The attribute of the user's LDAP record containing the user's first +* First name attribute (optional) + * The attribute of the user's LDAP record containing the user's first name. This will be used to populate their account information. - Example: givenName + * Example: givenName -Surname name attribute (optional) - The attribute of the user's LDAP record containing the user's surname +* Surname name attribute (optional) + *The attribute of the user's LDAP record containing the user's surname This will be used to populate their account information. - Example: sn + * Example: sn -E-mail attribute (required) +* E-mail attribute (required) The attribute of the user's LDAP record containing the user's email address. This will be used to populate their account information. - Example: mail + * Example: mail |