Mercurial > prosody-wiki
diff mod_lib_ldap.wiki @ 317:629d6b524cb9
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 |
line wrap: on
line diff
--- a/mod_lib_ldap.wiki Wed Dec 05 11:23:19 2012 +0000 +++ b/mod_lib_ldap.wiki Wed Dec 05 11:30:08 2012 +0000 @@ -4,7 +4,20 @@ 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]). -== Configuration == += Installation = + +Simply copy ldap.lib.lua into your Prosody installation's plugins directory. + += Configuration = + +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: + + * hostname - Where your LDAP server is located + * bind_dn - The DN to perform queries as + * bind_password - The password to use for queries + * use_tls - Whether or not TLS should be used to connect to the LDAP server + * user.usernamefield - The LDAP field that contains a user's username + * user.basedn - The base DN for user records = API = @@ -26,4 +39,8 @@ == ldap.filter.combine_and(...) == -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). \ No newline at end of file +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). + += More Information = + +For more information, please consult the README.md file under prosody-modules/mod_lib_ldap. \ No newline at end of file