annotate mod_storage_ldap.wiki @ 420:eb372e6bb82f

mod_auth_ldap: Document the ldap_mode option
author Kim Alvefur <zash@zash.se>
date Tue, 21 Jan 2014 20:26:30 +0100
parents 469bcbdfe281
children 528721aaea46
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
315
2c18ba3f99d9 Created wiki page through web user interface.
rdhoelz@gmail.com
parents:
diff changeset
1 #summary LDAP storage for rosters, groups, and vcards
382
469bcbdfe281 mod_storage_ldap, mod_storage_mongodb: Add Type-Storage labels
Kim Alvefur <zash@zash.se>
parents: 319
diff changeset
2 #labels Type-Storage
315
2c18ba3f99d9 Created wiki page through web user interface.
rdhoelz@gmail.com
parents:
diff changeset
3
2c18ba3f99d9 Created wiki page through web user interface.
rdhoelz@gmail.com
parents:
diff changeset
4 = Introduction =
2c18ba3f99d9 Created wiki page through web user interface.
rdhoelz@gmail.com
parents:
diff changeset
5
319
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
6 See [mod_lib_ldap] for more information.
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
7
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
8 = Installation =
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
9
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
10 You must install [mod_lib_ldap] to use this module. After that, you need only copy mod_storage_ldap.lua and ldap/vcard.lib.lua to your Prosody installation's plugins directory. Make sure vcard.lib.lua is installed under plugins/ldap/.
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
11
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
12 = Configuration =
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
13
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
14 In addition to the configuration that [mod_lib_ldap] itself requires, this plugin also requires the following fields in the ldap section:
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
15
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
16 * user.namefield
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
17 * groups.memberfield
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
18 * groups.namefield
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
19 * groups.basedn
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
20 * vcard_format (optional)
e6e7ccdae143 Edited wiki page mod_storage_ldap through web user interface.
rdhoelz@gmail.com
parents: 315
diff changeset
21
382
469bcbdfe281 mod_storage_ldap, mod_storage_mongodb: Add Type-Storage labels
Kim Alvefur <zash@zash.se>
parents: 319
diff changeset
22 See the README.md distributed with [mod_lib_ldap] for details.