summaryrefslogtreecommitdiff
path: root/plugins/Ldap/README
diff options
context:
space:
mode:
authorCraig Andrews <candrews@integralblue.com>2009-11-05 13:59:19 -0500
committerCraig Andrews <candrews@integralblue.com>2009-11-05 13:59:19 -0500
commit73e45bbfd99f0aafc1b22ab4dbbfc4e4329fc254 (patch)
treee1045d8e00ec17a1b9f15d4df0e642e5aaa0bf0c /plugins/Ldap/README
parent066331bdf7496bed328ef545e409e121603da75b (diff)
Made the ldap plugin work, and add a readme
Diffstat (limited to 'plugins/Ldap/README')
-rw-r--r--plugins/Ldap/README16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/Ldap/README b/plugins/Ldap/README
new file mode 100644
index 000000000..8a5095a5d
--- /dev/null
+++ b/plugins/Ldap/README
@@ -0,0 +1,16 @@
+The LDAP plugin allows for StatusNet to handle authentication, authorization, and user information through LDAP.
+
+Installation
+============
+Add configuration entries to config.php. These entries are:
+
+The following are documented at http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
+$config['ldap']['binddn']
+$config['ldap']['bindpw']
+$config['ldap']['basedn']
+$config['ldap']['host']
+
+$config['ldap']['nickname_attribute'] Set this to the name of the ldap attribute that holds the username. For example, on Microsoft's Active Directory, this should be set to 'sAMAccountName'
+
+Finally, add "addPlugin('ldap');" to the bottom of your config.php
+