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