changeset 472:bb454e0cb7fc

Update mod_auth_ldap page
author Kim Alvefur <zash@zash.se>
date Tue, 05 Aug 2014 15:38:11 +0200
parents 5fbe553241a8
children 8c76b076a0a1
files mod_auth_ldap.wiki
diffstat 1 files changed, 12 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/mod_auth_ldap.wiki	Sun Jul 27 14:22:08 2014 +0000
+++ b/mod_auth_ldap.wiki	Tue Aug 05 15:38:11 2014 +0200
@@ -7,6 +7,10 @@
 
 This is a Prosody authentication plugin which uses LDAP as the backend.
 
+= Dependecies =
+
+This module depends on [http://www.keplerproject.org/lualdap/ LuaLDAP] for connecting to an LDAP server.
+
 = Configuration =
 
 Copy the module to the prosody modules/plugins directory.
@@ -14,18 +18,19 @@
 In Prosody's configuration file, under the desired host section, add:
 {{{
 	authentication = "ldap"
+	ldap_base = "ou=people,dc=example,dc=com"
 }}}
 
 LDAP options are:
 || *Name*        || *Description*                                      || *Default value*  ||
-|| ldap_server   || space-separated list of hostnames or IPs, optionally with port numbers (e.g. "localhost:8389") || "localhost"      ||
-|| ldap_rootdn   || the distinguished name to auth against             || "" (anonymous)   ||
-|| ldap_password || the password                                       || ""               ||
-|| ldap_filter   || search filter, with $user and $host substituded for user- and hostname || "(uid=$user)"    ||
-|| ldap_scope    || search scope. other values: "base" and "subtree"   || "onelevel"       ||
+|| ldap_server   || Space-separated list of hostnames or IPs, optionally with port numbers (e.g. "localhost:8389") || "localhost"      ||
+|| ldap_rootdn   || The distinguished name to auth against             || "" (anonymous)   ||
+|| ldap_password || Password for rootdn                                || ""               ||
+|| ldap_filter   || Search filter, with $user and $host substituded for user- and hostname || "(uid=$user)"    ||
+|| ldap_scope    || Search scope. other values: "base" and "subtree"   || "onelevel"       ||
 || ldap_tls      || Enable TLS (StartTLS) to connect to LDAP (can be true or false). The non-standard 'LDAPS' protocol is not supported. || false            ||
 || ldap_base     || LDAP base directory which stores user accounts     || This is required ||
-|| ldap_mode     || How passwords are validated.                       || "getpasswd" if ldap_rootdn is set, "bind" otherwise ||
+|| ldap_mode     || How passwords are validated.                       || "bind"           ||
 
 *Note:*  lua-ldap reads from /etc/ldap/ldap.conf and other files like
 ~prosody/.ldaprc if they exist.  Users wanting to use a particular TLS
@@ -43,4 +48,4 @@
 
 = Compatibility =
 
-|| 0.8 and above || should work ||
\ No newline at end of file
+|| 0.8 and above || should work ||