# HG changeset patch
# User Waqas Hussain <waqas20@gmail.com>
# Date 1277927609 -18000
# Node ID eb945500dae49943376b44d64a8b4da9c6e7657c
# Parent  927270e0b963879634838deb7b31effb314217d5
mod_auth_ldap: Added some documentation.

diff -r 927270e0b963 -r eb945500dae4 mod_auth_ldap.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_auth_ldap.wiki	Thu Jul 01 00:53:29 2010 +0500
@@ -0,0 +1,27 @@
+#summary LDAP authentication module
+#labels Stage-Alpha
+
+= Introduction =
+
+This is a Prosody authentication plugin which uses LDAP as the backend.
+
+= Configuration =
+
+Copy the module to the prosody modules/plugins directory.
+
+In Prosody's configuration file, under the desired host section, add:
+{{{
+    authentication = "ldap"
+}}}
+
+LDAP options are:
+|| *Name*        || *Description*                                      || *Default value*  ||
+|| ldap_server   || space-separated list of hostnames or IPs           || "localhost"      ||
+|| ldap_rootdn   || the distinguished name to auth against             || "" (anonymous)   ||
+|| ldap_password || the password                                       || ""               ||
+|| ldap_tls      || Use TLS to connect to LDAP? (can be true or false) || false            ||
+|| ldap_base     || LDAP base directory which stores user accounts     || this is required ||
+
+= Compatibility =
+
+|| trunk || Untested, but should work ||