Diff

mod_storage_ldap/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 1821:79b9bd84b91c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_ldap/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,34 @@
+---
+labels:
+- 'Type-Storage'
+summary: 'LDAP storage for rosters, groups, and vcards'
+...
+
+Introduction
+============
+
+See [mod\_lib\_ldap](mod_lib_ldap.html) for more information.
+
+Installation
+============
+
+You must install [mod\_lib\_ldap](mod_lib_ldap.html) 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/.
+
+Configuration
+=============
+
+In addition to the configuration that [mod\_lib\_ldap](mod_lib_ldap.html)
+itself requires, this plugin also requires the following fields in the
+ldap section:
+
+-   user.namefield
+-   groups.memberfield
+-   groups.namefield
+-   groups.basedn
+-   vcard\_format (optional)
+
+See the README.html distributed with [mod\_lib\_ldap](mod_lib_ldap.html) for
+details.