Update doc comment for Awesomeness plugin

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

diff --git a/plugins/LdapAuthorization/README b/plugins/LdapAuthorization/README
index 2166b272660d56816196ac7bc18e70e87bf567da..3a6d8d25e005eaefdfc94e1ddae6f1f09434d765 100644 (file)
--- a/plugins/LdapAuthorization/README
+++ b/plugins/LdapAuthorization/README
@@ -11,12 +11,15 @@ You *cannot* use this plugin without the LDAP Authentication plugin
 
 Settings
 ========
-provider_name*: name of the LDAP authentication provider that this plugin works with.
+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): should this plugin be authoritative for
     authorization?
 uniqueMember_attribute ('uniqueMember')*: the attribute of a group
     that lists the DNs of its members
-roles_to_groups*: array that maps StatusNet roles to LDAP groups
+roles_to_groups: array that maps StatusNet roles to LDAP groups
     some StatusNet roles are: moderator, administrator, sandboxed, silenced
 login_group: if this is set to a group DN, only members of that group will be
     allowed to login
@@ -45,6 +48,9 @@ filter: Default search filter.
 scope: Default search scope.
     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
 
+attributes: an array that relates StatusNet user attributes to LDAP ones
+    username*: LDAP attribute value entered when authenticating to StatusNet
+
 * required
 default values are in (parenthesis)
 
@@ -72,7 +78,7 @@ addPlugin('ldapAuthentication', array(
 addPlugin('ldapAuthorization', array(
     'provider_name'=>'Example',
     'authoritative'=>false,
-    'uniqueMember_attribute'=>'uniqueMember',
+    'uniqueMember_attribute'=>'member',
     'roles_to_groups'=> array(
         'moderator'=>'CN=SN-Moderators,OU=Users,OU=StatusNet,OU=US,DC=americas,DC=global,DC=loc',
         'administrator'=> array('CN=System-Adminstrators,OU=Users,OU=StatusNet,OU=US,DC=americas,DC=global,DC=loc',
@@ -81,6 +87,8 @@ addPlugin('ldapAuthorization', array(
     'binddn'=>'username',
     'bindpw'=>'password',
     'basedn'=>'OU=Users,OU=StatusNet,OU=US,DC=americas,DC=global,DC=loc',
-    'host'=>array('server1', 'server2')
+    'host'=>array('server1', 'server2'),
+    'attributes'=>array(
+        'username'=>'sAMAccountName')
 ));