From f1fa9b69aacc7c259ce367a62d25695793293187 Mon Sep 17 00:00:00 2001
From: andryyy <andre.peters@debinux.de>
Date: Thu, 12 Nov 2020 08:52:02 +0100
Subject: [PATCH] add info about pw schemes

---
 docs/model-pws.md | 28 ++++++++++++++++++++++++++++
 mkdocs.yml        |  1 +
 2 files changed, 29 insertions(+)
 create mode 100644 docs/model-pws.md

diff --git a/docs/model-pws.md b/docs/model-pws.md
new file mode 100644
index 000000000..78c935e93
--- /dev/null
+++ b/docs/model-pws.md
@@ -0,0 +1,28 @@
+# Fully supported hashing methods
+
+The most current mailcow fully supports the following hashing methods.
+The default hashing method is written in bold:
+
+- **BLF-CRYPT**
+- SSHA256
+- SSHA512
+
+The methods above can be used in `mailcow.conf` as `MAILCOW_PASS_SCHEME` value.
+
+## Read-only hashing methods
+
+The following methods are supported **read only**. 
+
+- MD5-CRYPT
+- PLAIN-MD5
+- SHA512-CRYPT
+
+That means mailcow is able to verify users with a hash like `{PLAIN-MD5}1a1dc91c907325c69271ddf0c944bc72` from the database.
+
+The value of `MAILCOW_PASS_SCHEME` will _always_ be used to encrypt new passwords.
+
+---
+
+> I changed the password hashes in the "mailbox" SQL table and cannot login.
+
+A "view" needs to be updated. You can trigger this by restarting sogo-mailcow: `docker-compose restart sogo-mailcow`
diff --git a/mkdocs.yml b/mkdocs.yml
index ac539bb05..621031721 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -43,6 +43,7 @@ nav:
 - 'Models':
   - 'Sender and receiver model': 'model-sender_rcv.md'
   - 'ACL': 'model-acl.md'
+  - 'Password hashing': 'model-passwd.md'
 - 'Debugging & Troubleshooting':
     - 'Introduction': debug.md
     - 'Logs': 'debug-logs.md'