Merge branch '1.1.x' of gitorious.org:statusnet/mainline into 1.1.x

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

diff --git a/plugins/LdapAuthentication/README b/plugins/LdapAuthentication/README
index 2226159c2e8a52802e091f786be22f503ffd693f..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
@@ -42,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
@@ -79,4 +85,3 @@ addPlugin('ldapAuthentication', array(
         'fullname'=>'displayName',
         'password'=>'unicodePwd')
 ));
-