plugins/LdapAuthentication/README

   1 The LDAP Authentication plugin allows for StatusNet to handle authentication
   2 through LDAP.
   3
   4 Installation
   5 ============
   6 add "addPlugin('ldapAuthentication',
   7     array('setting'=>'value', 'setting2'=>'value2', ...);"
   8 to the bottom of your config.php
   9
  10 Settings
  11 ========
  12 provider_name*: a unique name for this authentication provider.
  13 authoritative (false): Set to true if LDAP's responses are authoritative
  14     (if authorative and LDAP fails, no other password checking will be done).
  15 autoregistration (false): Set to true if users should be automatically created
  16     when they attempt to login.
  17 email_changeable (true): Are users allowed to change their email address?
  18     (true or false)
  19 password_changeable (true): Are users allowed to change their passwords?
  20     (true or false)
  21
  22 host*: LDAP server name to connect to. You can provide several hosts in an
  23     array in which case the hosts are tried from left to right.
  24     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  25 port: Port on the server.
  26     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  27 version: LDAP version.
  28     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  29 starttls: TLS is started after connecting.
  30     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  31 binddn: The distinguished name to bind as (username).
  32     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  33 bindpw: Password for the binddn.
  34     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  35 basedn*: LDAP base name (root directory).
  36     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  37 options: See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  38 filter: Default search filter.
  39     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  40 scope: Default search scope.
  41     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  42
  43 attributes: an array that relates StatusNet user attributes to LDAP ones
  44     username*: LDAP attribute value entered when authenticating to StatusNet
  45     nickname*: LDAP attribute value shown as the user's nickname
  46     email
  47     fullname
  48     homepage
  49     location
  50
  51 * required
  52 default values are in (parenthesis)
  53
  54 For most LDAP installations, the "nickname" and "username" attributes should
  55     be the same.
  56
  57 Example
  58 =======
  59 Here's an example of an LDAP plugin configuration that connects to
  60     Microsoft Active Directory.
  61
  62 addPlugin('ldapAuthentication', array(
  63     'provider_name'=>'Example',
  64     'authoritative'=>true,
  65     'autoregistration'=>true,
  66     'binddn'=>'username',
  67     'bindpw'=>'password',
  68     'basedn'=>'OU=Users,OU=StatusNet,OU=US,DC=americas,DC=global,DC=loc',
  69     'host'=>array('server1', 'server2'),
  70     'attributes'=>array(
  71         'username'=>'sAMAccountName',
  72         'nickname'=>'sAMAccountName',
  73         'email'=>'mail',
  74         'fullname'=>'displayName')
  75 ));
  76