From 029afd67556da1b661b593b2a7b38ee0fb218eb7 Mon Sep 17 00:00:00 2001 From: DerLinkman Date: Sun, 30 Jan 2022 14:24:07 +0100 Subject: [PATCH] Added Model Section + Translate to German --- docs/models/model-acl.de.md | 21 +++++++++++++ docs/models/model-acl.en.md | 21 +++++++++++++ docs/models/model-passwd.de.md | 49 ++++++++++++++++++++++++++++++ docs/models/model-passwd.en.md | 49 ++++++++++++++++++++++++++++++ docs/models/model-sender_rcv.de.md | 41 +++++++++++++++++++++++++ docs/models/model-sender_rcv.en.md | 41 +++++++++++++++++++++++++ mkdocs.yml | 6 ++-- 7 files changed, 225 insertions(+), 3 deletions(-) create mode 100644 docs/models/model-acl.de.md create mode 100644 docs/models/model-acl.en.md create mode 100644 docs/models/model-passwd.de.md create mode 100644 docs/models/model-passwd.en.md create mode 100644 docs/models/model-sender_rcv.de.md create mode 100644 docs/models/model-sender_rcv.en.md diff --git a/docs/models/model-acl.de.md b/docs/models/model-acl.de.md new file mode 100644 index 000000000..10ae8c3d4 --- /dev/null +++ b/docs/models/model-acl.de.md @@ -0,0 +1,21 @@ +Die Bearbeitung eines Domänenadministrators oder eines Mailboxbenutzers ermöglicht es, Einschränkungen für dieses Konto festzulegen. + +**Wichtig**: Bei sich überschneidenden Modulen wie Synchronisierungsaufträgen, auf die sowohl Domänenadministratoren als auch Mailbox-Benutzer Zugriff erhalten können, werden die Rechte des Domänenadministrators geerbt, wenn man sich als Mailbox-Benutzer anmeldet. + +Einige Beispiele: + +1. + +- Ein Domänenadministrator hat **keinen** Zugriff auf Synchronisierungsaufträge, kann sich aber als Mailbox-Benutzer anmelden +- Wenn er sich als Mailbox-Benutzer anmeldet, erhält er keinen Zugriff auf Synchronisierungsaufträge, auch wenn der betreffende Mailbox-Benutzer bei der direkten Anmeldung Zugriff _hat_. + +2. + +- Ein Domänenadministrator **hat** Zugriff auf Synchronisierungsaufträge und kann sich als Postfachbenutzer anmelden +- Der Mailbox-Benutzer, als der er sich anzumelden versucht, hat **keinen** Zugang zu Synchronisierungsaufträgen +- Der Domänenadministrator, der nun als Mailbox-Benutzer angemeldet ist, erbt die Berechtigung des Mailbox-Benutzers und kann auf Synchronisierungsaufträge zugreifen. + +3. + +- Ein Domänenadministrator meldet sich als Mailbox-Benutzer an +- Jede Berechtigung, die **nicht** in der ACL eines Domänenadministrators vorhanden ist, wird automatisch gewährt (Beispiel: zeitlich begrenzter Alias, TLS-Richtlinie usw.) \ No newline at end of file diff --git a/docs/models/model-acl.en.md b/docs/models/model-acl.en.md new file mode 100644 index 000000000..be821b7bf --- /dev/null +++ b/docs/models/model-acl.en.md @@ -0,0 +1,21 @@ +Editing a domain administrator or a mailbox user allows to set restrictions to that account. + +**Important**: For overlapping modules like sync jobs, which both domain administrators and mailbox users can be granted access to, the domain administrators permissions are inherited, when logging in as mailbox user. + +Some examples: + +1. + +- A domain administror has **not** access to sync jobs but can login as mailbox user +- When logging in as mailbox user, he does not gain access to sync jobs, even if the given mailbox user _has_ access when logging in directly + +2. + +- A domain administror **has** access to sync jobs and can login as mailbox user +- The mailbox user he tries to login as has **not** access to sync jobs +- The domain administrator, now logged in as mailbox user, inherits its permission to the mailbox user and can access sync jobs + +3. + +- A domain administrator logs in as mailbox user +- Every permission, that does **not** exist in a domain administrators ACL, is automatically granted (example: time-limited alias, TLS policy etc.) \ No newline at end of file diff --git a/docs/models/model-passwd.de.md b/docs/models/model-passwd.de.md new file mode 100644 index 000000000..01a083bec --- /dev/null +++ b/docs/models/model-passwd.de.md @@ -0,0 +1,49 @@ +## Vollständig unterstützte Hashing-Methoden + +Die aktuellste Version von mailcow unterstützt die folgenden Hashing-Methoden vollständig. +Die Standard-Hashing-Methode ist fett geschrieben: + +- **BLF-CRYPT** +- SSHA +- SSHA256 +- SSHA512 + +Die obigen Methoden können in `mailcow.conf` als `MAILCOW_PASS_SCHEME` Wert verwendet werden. + +## Nur-Lese-Hashing-Methoden + +Die folgenden Methoden werden **nur lesend** unterstützt. +Wenn Sie planen, SOGo zu benutzen (wie standardmäßig), benötigen Sie eine SOGo-kompatible Hash-Methode. Bitte beachten Sie den Hinweis am Ende dieser Seite, wie Sie die Ansicht bei Bedarf aktualisieren können. +Wenn SOGo deaktiviert ist, können alle unten aufgeführten Hashing-Methoden von mailcow und Dovecot gelesen werden. + +- ARGON2I (SOGo kompatibel) +- ARGON2ID (SOGo kompatibel) +- CLEAR +- CLEARTEXT +- CRYPT (SOGo-kompatibel) +- DES-CRYPT +- LDAP-MD5 (SOGo-kompatibel) +- MD5 (SOGo-kompatibel) +- MD5-CRYPT (SOGo-kompatibel) +- PBKDF2 (SOGo-kompatibel) +- PLAIN (SOGo-kompatibel) +- PLAIN-MD4 +- PLAIN-MD5 +- PLAIN-TRUNC +- SHA (SOGo-kompatibel) +- SHA1 (SOGo-kompatibel) +- SHA256 (SOGo-kompatibel) +- SHA256-CRYPT (SOGo-kompatibel) +- SHA512 (SOGo-kompatibel) +- SHA512-CRYPT (SOGo-kompatibel) +- SMD5 (SOGo kompatibel) + +Das bedeutet, mailcow ist in der Lage, Nutzer mit einem Hash wie `{MD5}1a1dc91c907325c69271ddf0c944bc72` aus der Datenbank zu verifizieren. + +Der Wert von `MAILCOW_PASS_SCHEME` wird _immer_ verwendet, um neue Passwörter zu verschlüsseln. + +--- + +> Ich habe die Passwort-Hashes in der SQL-Tabelle "Mailbox" geändert und kann mich nicht anmelden. + +Eine "Ansicht" muss aktualisiert werden. Sie können dies durch einen Neustart von sogo-mailcow auslösen: `docker-compose restart sogo-mailcow` \ No newline at end of file diff --git a/docs/models/model-passwd.en.md b/docs/models/model-passwd.en.md new file mode 100644 index 000000000..e77ffe0d6 --- /dev/null +++ b/docs/models/model-passwd.en.md @@ -0,0 +1,49 @@ +## Fully supported hashing methods + +The most current mailcow fully supports the following hashing methods. +The default hashing method is written in bold: + +- **BLF-CRYPT** +- SSHA +- 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**. +If you plan to use SOGo (as per default), you need a SOGo compatible hashing method. Please see the note at the bottom of this page how to update the view if necessary. +With SOGo disabled, all hashing methods below will be able to be read by mailcow and Dovecot. + +- ARGON2I (SOGo compatible) +- ARGON2ID (SOGo compatible) +- CLEAR +- CLEARTEXT +- CRYPT (SOGo compatible) +- DES-CRYPT +- LDAP-MD5 (SOGo compatible) +- MD5 (SOGo compatible) +- MD5-CRYPT (SOGo compatible) +- PBKDF2 (SOGo compatible) +- PLAIN (SOGo compatible) +- PLAIN-MD4 +- PLAIN-MD5 +- PLAIN-TRUNC +- SHA (SOGo compatible) +- SHA1 (SOGo compatible) +- SHA256 (SOGo compatible) +- SHA256-CRYPT (SOGo compatible) +- SHA512 (SOGo compatible) +- SHA512-CRYPT (SOGo compatible) +- SMD5 (SOGo compatible) + +That means mailcow is able to verify users with a hash like `{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` \ No newline at end of file diff --git a/docs/models/model-sender_rcv.de.md b/docs/models/model-sender_rcv.de.md new file mode 100644 index 000000000..4a2395ee5 --- /dev/null +++ b/docs/models/model-sender_rcv.de.md @@ -0,0 +1,41 @@ +Wenn eine Mailbox erstellt wird, kann ein Benutzer Mails von seiner eigenen Mailboxadresse senden und empfangen. + + Die Mailbox me@example.org wird erstellt. example.org ist eine primäre Domäne. + Hinweis: Eine Mailbox kann nicht in einer Alias-Domäne erstellt werden. + + me@example.org ist nur als me@example.org bekannt. + me@example.org darf als me@example.org senden. + +Wir können eine Alias-Domäne für example.org hinzufügen: + + Die Alias-Domäne alias.com wird hinzugefügt und der primären Domäne example.org zugewiesen. + me@example.org ist nun als me@example.org und me@alias.com bekannt. + me@example.org darf nun als me@example.org und me@alias.com senden. + +Wir können Aliase für eine Mailbox hinzufügen, um Mails von dieser neuen Adresse zu empfangen und zu senden. + +Es ist wichtig zu wissen, dass Sie nicht in der Lage sind, Mails für `my-alias@my-alias-domain.tld` zu empfangen. Sie müssen diesen speziellen Alias erstellen. + + me@example.org wird der Alias alias@example.org zugewiesen. + me@example.org ist jetzt bekannt als me@example.org, me@alias.com, alias@example.org + + me@example.org ist NICHT als alias@alias.com bekannt. + +Bitte beachten Sie, dass dies nicht für "catch-all"-Aliasnamen gilt: + + Die Alias-Domäne alias.com wird hinzugefügt und der primären Domäne example.org zugewiesen + me@example.org wird der Catch-all-Alias @example.org zugewiesen + me@example.org ist weiterhin nur als me@example.org bekannt, was die einzige verfügbare send-as Option ist. + + Jede an alias.com gesendete E-Mail wird mit dem Catch-All-Alias für example.org übereinstimmen. + +Administratoren und Domänenadministratoren können Postfächer bearbeiten, um bestimmten Benutzern zu erlauben, als andere Postfachbenutzer zu senden (sie zu "delegieren"). + +Sie können zwischen Mailbox-Benutzern wählen oder die Absenderprüfung für Domänen komplett deaktivieren. + +### SOGo "Mail von"-Adressen + +Mailbox-Benutzer können natürlich ihre eigene Mailbox-Adresse auswählen, sowie alle Alias-Adressen und Aliase, die über Alias-Domänen existieren. + +Wenn Sie einen anderen _existierenden_ Mailbox-Benutzer als Ihre "Mail von"-Adresse auswählen wollen, muss dieser Benutzer Ihnen den Zugriff über SOGo delegieren (siehe SOGo-Dokumentation). Außerdem muss ein mailcow (Domain) Administrator +Ihnen den Zugang wie oben beschrieben gewähren. \ No newline at end of file diff --git a/docs/models/model-sender_rcv.en.md b/docs/models/model-sender_rcv.en.md new file mode 100644 index 000000000..ffc586520 --- /dev/null +++ b/docs/models/model-sender_rcv.en.md @@ -0,0 +1,41 @@ +When a mailbox is created, a user is allowed to send mail from and receive mail for his own mailbox address. + + Mailbox me@example.org is created. example.org is a primary domain. + Note: a mailbox cannot be created in an alias domain. + + me@example.org is only known as me@example.org. + me@example.org is allowed to send as me@example.org. + +We can add an alias domain for example.org: + + Alias domain alias.com is added and assigned to primary domain example.org. + me@example.org is now known as me@example.org and me@alias.com. + me@example.org is now allowed to send as me@example.org and me@alias.com. + +We can add aliases for a mailbox to receive mail for and to send from this new address. + +It is important to know, that you are not able to receive mail for `my-alias@my-alias-domain.tld`. You would need to create this particular alias. + + me@example.org is assigned the alias alias@example.org + me@example.org is now known as me@example.org, me@alias.com, alias@example.org + + me@example.org is NOT known as alias@alias.com. + +Please note that this does not apply to catch-all aliases: + + Alias domain alias.com is added and assigned to primary domain example.org + me@example.org is assigned the catch-all alias @example.org + me@example.org is still just known as me@example.org, which is the only available send-as option + + Any email send to alias.com will match the catch-all alias for example.org + +Administrators and domain administrators can edit mailboxes to allow specific users to send as other mailbox users ("delegate" them). + +You can choose between mailbox users or completely disable the sender check for domains. + +### SOGo "mail from" addresses + +Mailbox users can, obviously, select their own mailbox address, as well as all alias addresses and aliases that exist through alias domains. + +If you want to select another _existing_ mailbox user as your "mail from" address, this user has to delegate you access through SOGo (see SOGo documentation). Moreover a mailcow (domain) administrator +needs to grant you access as described above. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 81c938a32..cb8f9f660 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -48,9 +48,9 @@ nav: - 'SNAT': 'post_installation/firststeps-snat.md' - 'Sync job migration': 'post_installation/firststeps-sync_jobs_migration.md' - 'Models': - - 'ACL': 'model-acl.md' - - 'Password hashing': 'model-passwd.md' - - 'Sender and receiver model': 'model-sender_rcv.md' + - 'ACL': 'models/model-acl.md' + - 'Password hashing': 'models/model-passwd.md' + - 'Sender and receiver model': 'models/model-sender_rcv.md' - 'General Troubleshooting': - 'Introduction': 'debug.md' - 'Admin login to SOGo': 'debug-admin_login_sogo.md'