ldapauth/README.md

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