Move addon-specific config to config/addon.ini.php
[friendica-addons.git/.git] / ldapauth / README
1 Authenticate a user against an LDAP directory
2 Useful for Windows Active Directory and other LDAP-based organisations
3 to maintain a single password across the organisation.
4 Optionally authenticates only if a member of a given group in the directory.
5
6 By default, the person must have registered with Friendica using the normal registration
7 procedures in order to have a Friendica user record, contact, and profile.
8 However, it's possible with an option to automate the creation of a Friendica basic account.
9
10 Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site
11 ldap.conf file to the signing cert for your LDAP server.
12
13 The configuration options for this module may be set in the config/addon.ini.php file
14 e.g.:
15
16         [ldapauth]
17         // ldap hostname server - required
18         ldap_server = host.example.com
19         // dn to search users - required
20         ldap_searchdn = ou=users,dc=example,dc=com
21         // attribute to find username - required
22         ldap_userattr = uid
23
24         // admin dn - optional - only if ldap server dont have anonymous access
25         ldap_binddn = cn=admin,dc=example,dc=com
26         // admin password - optional - only if ldap server dont have anonymous access
27         ldap_bindpw = password
28
29         // for create Friendica account if user exist in ldap
30         //     required an email and a simple (beautiful) nickname on user ldap object
31         //   active account creation - optional - default none
32         ldap_autocreateaccount = true
33         //   attribute to get email - optional - default : 'mail'
34         ldap_autocreateaccount_emailattribute = mail
35         //   attribute to get nickname - optional - default : 'givenName'
36         ldap_autocreateaccount_nameattribute = givenName
37
38 ...etc.