LDAP backends documentation

doc/backends.rst

@@ -0,0 +1,36 @@
+Backends
+#############
+
+.. contents::
+   :local:
+
+LDAP
+====
+
+Canaille can integrate with several OpenLDAP overlays:
+
+memberof / refint
+-----------------
+
+*memberof* and *refint* overlays are needed for the Canaille group membership to work correctly.
+
+Here is a configuration example compatible with canaille:
+
+.. literalinclude :: ../demo/ldif/memberof-config.ldif
+   :language: ldif
+
+.. literalinclude :: ../demo/ldif/refint-config.ldif
+   :language: ldif
+
+ppolicy
+-------
+
+If *ppolicy* is configured and the ``pwdEndTime`` attribute is available (since OpenLDAP 2.6), then account locking support will be enabled in canaille. To allow users to manage account expiration, they need to have a *write* permission on the ``lock_date`` attribute.
+
+Here is a configuration example compatible with canaille:
+
+.. literalinclude :: ../demo/ldif/ppolicy-config.ldif
+   :language: ldif
+
+.. literalinclude :: ../demo/ldif/ppolicy.ldif
+   :language: ldif

doc/index.rst

@@ -34,6 +34,7 @@ Table of contents
    :maxdepth: 2
 
    install
+   backends
    configuration
    contributing
    specifications

poetry.lock

@@ -1199,6 +1199,19 @@ files = [
 [package.extras]
 plugins = ["importlib-metadata"]
 
+[[package]]
+name = "pygments-ldif"
+version = "1.0.1"
+description = "LDAP Data Interchange Format (LDIF) lexer for Pygments"
+optional = false
+python-versions = "*"
+files = [
+    {file = "pygments-ldif-1.0.1.tar.gz", hash = "sha256:df303ce8f3b74ab659afeb6adb12d89e9352b18228c0742fbc080b4e49b5e0c7"},
+]
+
+[package.dependencies]
+Pygments = "*"
+
 [[package]]
 name = "pyquery"
 version = "2.0.0"
@@ -1939,4 +1952,4 @@ sentry = ["sentry-sdk"]
 [metadata]
 lock-version = "2.0"
 python-versions = ">=3.7, <4"
-content-hash = "ea6edd79777591d8c6232b5cd2d712a4de68e72475aca7b7c6417328eac5ea61"
+content-hash = "32d6537f3fe1c010fba20f1bff7f04e05df486aac5d7088074c447dec8ec090e"

pyproject.toml

@@ -59,6 +59,7 @@ optional = true
 "sphinx" = "*"
 "sphinx-rtd-theme" = "*"
 "sphinx-issues" = "*"
+pygments-ldif = "^1.0.1"
 
 [tool.poetry.group.dev.dependencies]
 coverage = {version = "*", extras=["toml"]}