pub-solar/forgejo
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Updated the LDAP module readme.

Browse source
This commit is contained in:
Sergio Benitez 2015-08-12 17:08:16 -07:00
parent 7d84d4a8f0
commit f8a4ab25fd
1 changed files with 29 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
modules/auth/ldap/README.md
View file

@ -16,49 +16,49 @@ retrieved and passed to the Gogs login infrastructure.
To use this module, add an LDAP authentication source via the Authentications To use this module, add an LDAP authentication source via the Authentications
section in the admin panel. The fields should be set as follows: section in the admin panel. The fields should be set as follows:
Authorization Name (required) * Authorization Name **(required)**
A name to assign to the new method of authorization. * A name to assign to the new method of authorization.
Host (required) * Host **(required)**
The address where the LDAP server can be reached. * The address where the LDAP server can be reached.
Example: mydomain.com * Example: mydomain.com
Port (required) * Port **(required)**
The port to use when connecting to the server. * The port to use when connecting to the server.
Example: 636 * Example: 636
Enable TLS Encryption (optional) * Enable TLS Encryption (optional)
Whether to use TLS when connecting to the LDAP server. * Whether to use TLS when connecting to the LDAP server.
Bind DN (optional) * Bind DN (optional)
The DN to bind to the LDAP server with when searching for the user. * The DN to bind to the LDAP server with when searching for the user.
This may be left blank to perform an anonymous search. 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) * Bind Password (optional)
The password for the Bind DN specified above, if any. * The password for the Bind DN specified above, if any.
User Search Base (required) * User Search Base **(required)**
The LDAP base at which user accounts will be searched for. * The LDAP base at which user accounts will be searched for.
Example: ou=Users,dc=mydomain,dc=com * Example: ou=Users,dc=mydomain,dc=com
User Filter (required) * User Filter **(required)**
An LDAP filter declaring how to find the user record that is attempting * An LDAP filter declaring how to find the user record that is attempting
to authenticate. The '%s' matching parameter will be substituted with to authenticate. The '%s' matching parameter will be substituted with
the user's username. the user's username.
Example: (&(objectClass=posixAccount)(uid=%s)) * Example: (&(objectClass=posixAccount)(uid=%s))
First name attribute (optional) * First name attribute (optional)
The attribute of the user's LDAP record containing the user's first * The attribute of the user's LDAP record containing the user's first
name. This will be used to populate their account information. name. This will be used to populate their account information.
Example: givenName * Example: givenName
Surname name attribute (optional) * Surname name attribute (optional)
The attribute of the user's LDAP record containing the user's surname *The attribute of the user's LDAP record containing the user's surname
This will be used to populate their account information. 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 The attribute of the user's LDAP record containing the user's email
address. This will be used to populate their account information. address. This will be used to populate their account information.
Example: mail * Example: mail