view mod_storage_ldap/README.markdown @ 5734:cef8bce2d71b

luacheck: Add new module API methods from trunk See * trunk rev 4d4f9e42bcf8 * trunk rev 65fb0d7a2312 * trunk rev c9ef35fab0b1
author Kim Alvefur <zash@zash.se>
date Mon, 27 Nov 2023 07:10:06 +0100
parents 79b9bd84b91c
children
line wrap: on
line source

---
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.