plugins/LdapAuthentication/README

   1 The LDAP Authentication plugin allows for StatusNet to handle authentication through LDAP.
   2
   3 Installation
   4 ============
   5 add "addPlugin('ldapAuthentication', array('setting'=>'value', 'setting2'=>'value2', ...);" to the bottom of your config.php
   6
   7 Settings
   8 ========
   9 provider_name*: a unique name for this authentication provider.
  10 authoritative (false): Set to true if LDAP's responses are authoritative (meaning if LDAP fails, do check any other plugins or the internal password database).
  11 autoregistration (false): Set to true if users should be automatically created when they attempt to login.
  12 email_changeable (true): Are users allowed to change their email address? (true or false)
  13 password_changeable (true): Are users allowed to change their passwords? (true or false)
  14
  15 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.. See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  16 port: Port on the server. See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  17 version: LDAP version. See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  18 starttls: TLS is started after connecting. See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  19 binddn: The distinguished name to bind as (username). See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  20 bindpw: Password for the binddn. See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  21 basedn*: LDAP base name (root directory). See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  22 options: See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  23 filter: Default search filter. See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  24 scope: Default search scope. See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  25
  26 attributes: an array with the key being the StatusNet user attribute name, and the value the LDAP attribute name
  27     username*
  28     nickname*
  29     email
  30     fullname
  31     homepage
  32     location
  33
  34 * required
  35 default values are in (parenthesis)
  36
  37 Example
  38 =======
  39 Here's an example of an LDAP plugin configuration that connects to Microsoft Active Directory.
  40
  41 addPlugin('ldapAuthentication', array(
  42     'provider_name'=>'Example',
  43     'authoritative'=>true,
  44     'autoregistration'=>true,
  45     'binddn'=>'username',
  46     'bindpw'=>'password',
  47     'basedn'=>'OU=Users,OU=StatusNet,OU=US,DC=americas,DC=global,DC=loc',
  48     'host'=>array('server1', 'server2'),
  49     'attributes'=>array(
  50         'nickname'=>'sAMAccountName',
  51         'email'=>'mail',
  52         'fullname'=>'displayName')
  53 ));