From 7a5a88384d855ee6b8bff14ef5dffb27b6f6931e Mon Sep 17 00:00:00 2001
From: PHIDIAS <phidias@aperx.org>
Date: Sat, 7 Jun 2025 02:13:26 +0900
Subject: [PATCH] example_configs: add Mailcow  (#1188)

---
 README.md                  |  1 +
 example_configs/mailcow.md | 45 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+)
 create mode 100644 example_configs/mailcow.md

diff --git a/README.md b/README.md
index 29a8a6b..af4dd16 100644
--- a/README.md
+++ b/README.md
@@ -624,6 +624,7 @@ folder for help with:
 - [Kimai](example_configs/kimai.yaml)
 - [LibreNMS](example_configs/librenms.md)
 - [Maddy](example_configs/maddy.md)
+- [Mailcow](example_configs/mailcow.md)
 - [Mastodon](example_configs/mastodon.env.example)
 - [Matrix](example_configs/matrix_synapse.yml)
 - [Mealie](example_configs/mealie.md)
diff --git a/example_configs/mailcow.md b/example_configs/mailcow.md
new file mode 100644
index 0000000..a9d3a84
--- /dev/null
+++ b/example_configs/mailcow.md
@@ -0,0 +1,45 @@
+# Mailcow LLDAP example config
+
+## Setting location
+
+First, go to `System` > `Configuration`.
+
+And then, `Access` > `Identity Provider`.
+
+## Configuration
+
+Set `Identity Provider` as `LDAP`
+
+Set `Host` as the LLDAP IP.
+
+Set `Port` as the LLDAP port, which should be `3890` by default.
+
+Set `Use SSL` to `False`.
+
+Set `Use StartTLS` (SSL port will not be used) to `False`.
+
+Set `Ignore SSL Errors` (validation bypass) to `False`.
+
+When using `Use SSL` (LDAPS), `Port` should be set to `6360` instead, the default port if unchanged.
+
+These three options should be `False`, unless there is a properly-signed non self-signed certificate for LLDAP installed.
+
+Set `Base DN` in the format like `dc=example,dc=org`.
+
+Set `Username Field` as `mail` or `uid`.
+
+Set `Filter` as `(objectclass=person)`.
+
+Set `Attribute Field` also as `mail`.
+
+Set `Bind DN` in the format like `uid=username,ou=people,dc=example,dc=org`.
+
+Set `Bind Password` as the password of the user given in `Bind DN`
+
+Leave `Attribute Mapping` as default if you not sure what it means.
+
+Set `Auto-create users on login`, `Periodic Full Sync`, `Import Users` to `True`.
+
+Set `Sync / Import interval (min)` to `15`
+
+Try `Test Connection`, you should be able to connect it now.