summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAntoine Eiche <lewo@abesis.fr>2023-07-03 22:35:58 +0200
committerlewo <lewo@abesis.fr>2023-07-11 19:31:20 +0000
commit69a4b7ad67d2732ba1f86666b3d4d2d83b15200e (patch)
tree781632ac5c93c4ee4cc659e642ae67eaac1dcdb5 /docs
parent71b4c62d85660a13657ded9d5194d90f2bd8122e (diff)
ldap: add an entry in the doc
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst1
-rw-r--r--docs/ldap.rst14
2 files changed, 15 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 717eed0..2fd1e1a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -30,6 +30,7 @@ Welcome to NixOS Mailserver's documentation!
fts
flakes
autodiscovery
+ ldap
Indices and tables
==================
diff --git a/docs/ldap.rst b/docs/ldap.rst
new file mode 100644
index 0000000..efd975d
--- /dev/null
+++ b/docs/ldap.rst
@@ -0,0 +1,14 @@
+LDAP Support
+============
+
+It is possible to manage mail user accounts with LDAP rather than with
+the option `loginAccounts <options.html#mailserver-loginaccounts>`_.
+
+All related LDAP options are described in the `LDAP options section
+<options.html#mailserver-ldap>`_ and the `LDAP test
+<https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/blob/master/tests/ldap.nix>`_
+provides a getting started example.
+
+.. note::
+ The LDAP support can not be enabled if some accounts are also defined with ``mailserver.loginAccounts``.
+