friendica-addons/ldapauth/README

39 lines
1.6 KiB
Text
Raw Normal View History

2011-09-25 08:56:03 +00:00
Authenticate a user against an LDAP directory
Useful for Windows Active Directory and other LDAP-based organisations
to maintain a single password across the organisation.
Optionally authenticates only if a member of a given group in the directory.
By default, the person must have registered with Friendica using the normal registration
2012-01-31 11:06:20 +00:00
procedures in order to have a Friendica user record, contact, and profile.
2015-02-04 15:55:07 +00:00
However, it's possible with an option to automate the creation of a Friendica basic account.
2011-09-25 08:56:03 +00:00
Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site
ldap.conf file to the signing cert for your LDAP server.
2011-09-25 08:56:03 +00:00
The configuration options for this module may be set in the config/addon.ini.php file
2011-09-25 08:56:03 +00:00
e.g.:
[ldapauth]
// ldap hostname server - required
ldap_server = host.example.com
// dn to search users - required
ldap_searchdn = ou=users,dc=example,dc=com
// attribute to find username - required
ldap_userattr = uid
2015-02-04 15:55:07 +00:00
// admin dn - optional - only if ldap server dont have anonymous access
ldap_binddn = cn=admin,dc=example,dc=com
// admin password - optional - only if ldap server dont have anonymous access
ldap_bindpw = password
2015-02-04 15:55:07 +00:00
// for create Friendica account if user exist in ldap
// required an email and a simple (beautiful) nickname on user ldap object
// active account creation - optional - default none
ldap_autocreateaccount = true
// attribute to get email - optional - default : 'mail'
ldap_autocreateaccount_emailattribute = mail
// attribute to get nickname - optional - default : 'givenName'
ldap_autocreateaccount_nameattribute = givenName
2015-02-04 15:55:07 +00:00
2011-09-25 08:56:03 +00:00
...etc.