Mercurial > prosody-wiki

comparison mod_lib_ldap.wiki @ 317:629d6b524cb9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Edited wiki page mod_lib_ldap through web user interface.
author rdhoelz@gmail.com
date Wed, 05 Dec 2012 11:30:08 +0000
parents 03633ab9afb6
children
comparison
equal deleted inserted replaced
316:03633ab9afb6 317:629d6b524cb9
2 2
3 = Introduction = 3 = Introduction =
4 4
5 This module is used by other modules to access an LDAP server. It's pretty useless on its own; you should use it if you want to write your own LDAP-related module, or if you want to use one of mine ([mod_auth_ldap2], [mod_storage_ldap]). 5 This module is used by other modules to access an LDAP server. It's pretty useless on its own; you should use it if you want to write your own LDAP-related module, or if you want to use one of mine ([mod_auth_ldap2], [mod_storage_ldap]).
6 6
7 == Configuration == 7 = Installation =
8
9 Simply copy ldap.lib.lua into your Prosody installation's plugins directory.
10
11 = Configuration =
12
13 Configuration for this module (and all modules that use it) goes into the _ldap_ section of your prosody.cfg.lua file. Each plugin that uses it may add their own sections; this plugin relies on the following keys:
14
15 * hostname - Where your LDAP server is located
16 * bind_dn - The DN to perform queries as
17 * bind_password - The password to use for queries
18 * use_tls - Whether or not TLS should be used to connect to the LDAP server
19 * user.usernamefield - The LDAP field that contains a user's username
20 * user.basedn - The base DN for user records
8 21
9 = API = 22 = API =
10 23
11 == ldap.getconnection() == 24 == ldap.getconnection() ==
12 25
25 Used to fetch a single LDAP record given an LDAP query. A convenience function. 38 Used to fetch a single LDAP record given an LDAP query. A convenience function.
26 39
27 == ldap.filter.combine_and(...) == 40 == ldap.filter.combine_and(...) ==
28 41
29 Takes a list of LDAP filter expressions and returns a filter expression that results in the intersection of each given expression (it ANDs them together). 42 Takes a list of LDAP filter expressions and returns a filter expression that results in the intersection of each given expression (it ANDs them together).
43
44 = More Information =
45
46 For more information, please consult the README.md file under prosody-modules/mod_lib_ldap.