Mercurial > prosody-wiki

annotate mod_auth_ldap.wiki @ 137:eb945500dae4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_ldap: Added some documentation.
author Waqas Hussain <waqas20@gmail.com>
date Thu, 01 Jul 2010 00:53:29 +0500
parents
children dbe3fcc3dbbb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
137
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
1 #summary LDAP authentication module
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
2 #labels Stage-Alpha
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
3
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
4 = Introduction =
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
5
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
6 This is a Prosody authentication plugin which uses LDAP as the backend.
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
7
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
8 = Configuration =
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
9
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
10 Copy the module to the prosody modules/plugins directory.
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
11
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
12 In Prosody's configuration file, under the desired host section, add:
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
13 {{{
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
14 authentication = "ldap"
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15 }}}
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
16
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
17 LDAP options are:
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
18 || *Name* || *Description* || *Default value* ||
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
19 || ldap_server || space-separated list of hostnames or IPs || "localhost" ||
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
20 || ldap_rootdn || the distinguished name to auth against || "" (anonymous) ||
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
21 || ldap_password || the password || "" ||
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
22 || ldap_tls || Use TLS to connect to LDAP? (can be true or false) || false ||
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
23 || ldap_base || LDAP base directory which stores user accounts || this is required ||
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
24
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
25 = Compatibility =
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
26
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
27 || trunk || Untested, but should work ||