Merge branch 'master' into 1.1.x

[quix0rs-gnu-social.git] / plugins / LdapAuthentication / README

diff --git a/plugins/LdapAuthentication/README b/plugins/LdapAuthentication/README
index dc3f4ba884ae8bd1f14e5a99c1b7d9263a9131e1..a21ba4d483d2f1104207e13f364b74947a6749f0 100644 (file)
--- a/plugins/LdapAuthentication/README
+++ b/plugins/LdapAuthentication/README
@@ -9,7 +9,11 @@ to the bottom of your config.php
 
 Settings
 ========
-provider_name*: a unique name for this authentication provider.
+provider_name*: This is a identifier designated to the connection.
+    It's how StatusNet will refer to the authentication source.
+    For the most part, any name can be used, so long as each authentication
+    source has a different identifier. In most cases there will be only one
+    authentication source used.
 authoritative (false): Set to true if LDAP's responses are authoritative
     (if authorative and LDAP fails, no other password checking will be done).
 autoregistration (false): Set to true if users should be automatically created
@@ -18,6 +22,9 @@ email_changeable (true): Are users allowed to change their email address?
     (true or false)
 password_changeable (true): Are users allowed to change their passwords?
     (true or false)
+password_encoding: required if users are to be able to change their passwords
+    Possible values are: crypt, ext_des, md5crypt, blowfish, md5, sha, ssha,
+        smd5, ad, clear
 
 host*: LDAP server name to connect to. You can provide several hosts in an
     array in which case the hosts are tried from left to right.
@@ -39,6 +46,8 @@ filter: Default search filter.
     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
 scope: Default search scope.
     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
+schema_cachefile: File location to store ldap schema.
+schema_maxage: TTL for cache file.
 
 attributes: an array that relates StatusNet user attributes to LDAP ones
     username*: LDAP attribute value entered when authenticating to StatusNet
@@ -47,6 +56,7 @@ attributes: an array that relates StatusNet user attributes to LDAP ones
     fullname
     homepage
     location
+    password: required if users are to be able to change their passwords
 
 * required
 default values are in (parenthesis)
@@ -67,10 +77,11 @@ addPlugin('ldapAuthentication', array(
     'bindpw'=>'password',
     'basedn'=>'OU=Users,OU=StatusNet,OU=US,DC=americas,DC=global,DC=loc',
     'host'=>array('server1', 'server2'),
+    'password_encoding'=>'ad',
     'attributes'=>array(
         'username'=>'sAMAccountName',
         'nickname'=>'sAMAccountName',
         'email'=>'mail',
-        'fullname'=>'displayName')
+        'fullname'=>'displayName',
+        'password'=>'unicodePwd')
 ));
-