X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=ldapauth%2FREADME;h=ee09e94d67fe6ced31b82dae654bb793624b7820;hb=3ce1c8cf2e65581af5fe94c1273f9381987f9f89;hp=cf28ef1e06a4aef3117bf42750bb50a1bfc70e70;hpb=391f57fa395a3ea79e76c1df9e1d66766136ca0f;p=friendica-addons.git

diff --git a/ldapauth/README b/ldapauth/README
old mode 100755
new mode 100644
index cf28ef1e..ee09e94d
--- a/ldapauth/README
+++ b/ldapauth/README
@@ -1,17 +1,37 @@
 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.
 
-The person must have registered with Friendika using the normal registration 
-procedures in order to have a Friendika user record, contact, and profile.
+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. 
 
-The required configuration options for this module may be set in the .htconfig.php file
+The configuration options for this module may be set in the .htconfig.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';
+
+// 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';
+
 ...etc.