Merge pull request #749 from annando/notices

[friendica-addons.git] / ldapauth / README

diff --git a/ldapauth/README b/ldapauth/README
old mode 100755 (executable)
new mode 100644 (file)
index ee09e94..03e8b0d
--- a/ldapauth/README
+++ b/ldapauth/README
@@ -3,35 +3,36 @@ 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 
+By default, the person must have registered with Friendica using the normal registration
 procedures in order to have a Friendica user record, contact, and profile.
 However, it's possible with an option to automate the creation of a Friendica basic account.
 
 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. 
+ldap.conf file to the signing cert for your LDAP server.
 
-The configuration options for this module may be set in the .htconfig.php file
+The configuration options for this module may be set in the config/addon.ini.php file
 e.g.:
 
-// ldap hostname server - required
-$a->config['ldapauth']['ldap_server'] = 'host.example.com';
-// 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';
+       [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
 
-// 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';
+       // 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
 
-// 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';
+       // 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
 
 ...etc.