friendica-addons/ldapauth/README

38 lines
1.8 KiB
Plaintext
Raw Normal View History

2011-09-25 04:56:03 -04: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.
2015-02-04 10:55:07 -05:00
By default, the person must have registered with Friendica using the normal registration
2012-01-31 06:06:20 -05:00
procedures in order to have a Friendica user record, contact, and profile.
2015-02-04 10:55:07 -05:00
However, it's possible with an option to automate the creation of a Friendica basic account.
2011-09-25 04:56:03 -04: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.
2015-02-04 10:55:07 -05:00
The configuration options for this module may be set in the .htconfig.php file
2011-09-25 04:56:03 -04:00
e.g.:
2015-02-04 10:55:07 -05:00
// ldap hostname server - required
2011-09-25 04:56:03 -04:00
$a->config['ldapauth']['ldap_server'] = 'host.example.com';
2015-02-04 10:55:07 -05:00
// dn to search users - required
$a->config['ldapauth']['ldap_searchdn'] = 'ou=users,dc=example,dc=com';
// attribute to find username - required
$a->config['ldapauth']['ldap_userattr'] = 'uid';
// admin dn - optional - only if ldap server dont have anonymous access
$a->config['ldapauth']['ldap_binddn'] = 'cn=admin,dc=example,dc=com';
// admin password - optional - only if ldap server dont have anonymous access
$a->config['ldapauth']['ldap_bindpw'] = 'password';
// 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
$a->config['ldapauth']['ldap_autocreateaccount'] = 'true';
// attribute to get email - optional - default : 'mail'
$a->config['ldapauth']['ldap_autocreateaccount_emailattribute'] = 'mail';
// attribute to get nickname - optional - default : 'givenName'
$a->config['ldapauth']['ldap_autocreateaccount_nameattribute'] = 'givenName';
2011-09-25 04:56:03 -04:00
...etc.