#summary LDAP authentication module
#labels Stage-Alpha,Type-Auth

_*Note:* A modified version of this module is available, but is not yet committed here. The plan is to merge them, for more info see [http://groups.google.com/group/prosody-dev/browse_thread/thread/282e876116ae4177/906121492495ad35#906121492495ad35 this thread]._

= 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_filter   || search filter, with %s substituded for username    || "(uid=%s)"       ||
|| 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 =

|| 0.8 and above || should work ||