diff --git a/docs/assets/images/manual-guides/mailcow-domain_email_tags.de.png b/docs/assets/images/manual-guides/mailcow-domain_email_tags.de.png new file mode 100644 index 000000000..7d3345fb3 Binary files /dev/null and b/docs/assets/images/manual-guides/mailcow-domain_email_tags.de.png differ diff --git a/docs/assets/images/manual-guides/mailcow-domain_email_tags.png b/docs/assets/images/manual-guides/mailcow-domain_email_tags.png new file mode 100644 index 000000000..3f345d823 Binary files /dev/null and b/docs/assets/images/manual-guides/mailcow-domain_email_tags.png differ diff --git a/docs/assets/images/manual-guides/mailcow-domain_tags_ribbon.de.png b/docs/assets/images/manual-guides/mailcow-domain_tags_ribbon.de.png new file mode 100644 index 000000000..e719f2b5a Binary files /dev/null and b/docs/assets/images/manual-guides/mailcow-domain_tags_ribbon.de.png differ diff --git a/docs/assets/images/manual-guides/mailcow-domain_tags_ribbon.png b/docs/assets/images/manual-guides/mailcow-domain_tags_ribbon.png new file mode 100644 index 000000000..a2bb3616f Binary files /dev/null and b/docs/assets/images/manual-guides/mailcow-domain_tags_ribbon.png differ diff --git a/docs/assets/images/manual-guides/mailcow-netfilter_regex.de.png b/docs/assets/images/manual-guides/mailcow-netfilter_regex.de.png new file mode 100644 index 000000000..43673e31f Binary files /dev/null and b/docs/assets/images/manual-guides/mailcow-netfilter_regex.de.png differ diff --git a/docs/assets/images/manual-guides/mailcow-netfilter_regex.en.png b/docs/assets/images/manual-guides/mailcow-netfilter_regex.en.png new file mode 100644 index 000000000..0415ffe5c Binary files /dev/null and b/docs/assets/images/manual-guides/mailcow-netfilter_regex.en.png differ diff --git a/docs/assets/images/manual-guides/mailcow-netfilter_settings.de.png b/docs/assets/images/manual-guides/mailcow-netfilter_settings.de.png new file mode 100644 index 000000000..9ec35ffd7 Binary files /dev/null and b/docs/assets/images/manual-guides/mailcow-netfilter_settings.de.png differ diff --git a/docs/assets/images/manual-guides/mailcow-netfilter_settings.en.png b/docs/assets/images/manual-guides/mailcow-netfilter_settings.en.png new file mode 100644 index 000000000..e287d0a0c Binary files /dev/null and b/docs/assets/images/manual-guides/mailcow-netfilter_settings.en.png differ diff --git a/docs/i_u_m/i_u_m_update.de.md b/docs/i_u_m/i_u_m_update.de.md index 68b616db4..acede8962 100644 --- a/docs/i_u_m/i_u_m_update.de.md +++ b/docs/i_u_m/i_u_m_update.de.md @@ -27,6 +27,9 @@ Einige kleinere Konflikte werden automatisch korrigiert (zugunsten des mailcow: # - Starten Sie mailcow nicht, nachdem Sie ein Update durchgeführt haben ./update.sh --skip-start +# - Überspringt den ICMP Check auf die öffentlichen DNS Resolver (Bitte nur nutzen, wenn keinerlei ICMP Verbindungen von und zur mailcow erlaubt sind) +./update.sh --skip-ping-check + # - Erzwinge Update (unbeaufsichtigt, aber nicht unterstützt, Benutzung auf eigenes Risiko) ./update.sh --force @@ -70,6 +73,8 @@ docker-compose up -d Sie können sich in den Update-Mechanismus einklinken, indem Sie Skripte namens `pre_commit_hook.sh` und `post_commit_hook.sh` zu Ihrem mailcows-Root-Verzeichnis hinzufügen. Siehe [hier](../manual-guides/u_e-update-hooks.md) für weitere Details. -## Fußnoten +## Update-Zyklus -- Wir planen einen monatlichen Release-Zyklus für Updates ein. +- Wir planen an jedem ersten Dienstag eines Monats ein neues Hauptupdate zu veröffentlichen. +- Die Updates sind wie folgt nummeriert: `JJJJ-MM` (Beispiel: `2022-05`). +- Fehlerkorrekturen eines Hauptupdates werden bei uns als "Revisionen" wie a,b,c (Beispiele: `2022-05a`, `2022-05b` usw.) erscheinen. diff --git a/docs/i_u_m/i_u_m_update.en.md b/docs/i_u_m/i_u_m_update.en.md index 78351c8a7..6b6a838ae 100644 --- a/docs/i_u_m/i_u_m_update.en.md +++ b/docs/i_u_m/i_u_m_update.en.md @@ -27,6 +27,9 @@ Some minor conflicts will be auto-corrected (in favour for the mailcow: dockeriz # - Do not start mailcow after applying an update ./update.sh --skip-start +# - Skip ICMP Check to public DNS resolvers (Use it only if you´ve blocked any ICMP Connections to your mailcow machine) +./update.sh --skip-ping-check + # - Force update (unattended, but unsupported, use at own risk) ./update.sh --force @@ -70,6 +73,8 @@ docker-compose up -d You can hook into the update mechanism by adding scripts called `pre_commit_hook.sh` and `post_commit_hook.sh` to your mailcows root directory. See [this](../manual-guides/u_e-update-hooks.md) for more details. -## Footnotes +## Update Cycle -- We schedule a monthly release cycle for updates. +- We schedule a monthly release cycle for a major update at the first tuesday of the month. +- The releases are numbered like this: `YYYY-MM` (e.g. `2022-05`) +- Fixes for a main Update will be stated as "Revisions" like a,b,c (e.g. `2022-05a`, `2022-05b` etc.) \ No newline at end of file diff --git a/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-netfilter.de.md b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-netfilter.de.md new file mode 100644 index 000000000..643471883 --- /dev/null +++ b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-netfilter.de.md @@ -0,0 +1,29 @@ +## Netfilter Ban-Einstellungen ändern + +Um die Netfilter Ban-Einstellungen zu ändern navigieren Sie zu dem Menü Punkt: `Konfiguration -> Server-Konfiguration -> Konfiguration -> Fail2ban-Parameter`. + +Sie sollten dann dieses Fenster sehen: + +![Netfilter ban settings](../../assets/images/manual-guides/mailcow-netfilter_settings.de.png) + +Hier können Sie verschiedene Optionen für die Banns selbst festlegen. +Zum Beispiel die max. Ban-Zeit oder die max. Versuche bevor ein Ban ausgeführt wird. + + +## Netfilter Regex ändern + +!!! danger "Achtung" + Folgender Bereich erfordert zumindest grundlegende Regex kenntnisse.
+ Sollten Sie sich nicht sicher sein, was Sie dort tun, können wir Ihnen nur von der Umkonfiguration abraten. + +Sie können neben den Sperreinstellungen ebenfalls definieren, was genau aus den Logs der mailcow Container verwendet werden soll um einen möglichen Angreifer zu sperren. + +Dafür müssen Sie das Regex Feld erst einmal aufklappen, was dann in etwa so aussieht: + +![Netfilter Regex](../../assets/images/manual-guides/mailcow-netfilter_regex.de.png) + +Dort können Sie nun verschiedenste neue Filter-Regeln anlegen. + +!!! info "Hinweis" + Mit weiterschreitenden Updates ist es möglich, dass neue Netfilter Regex Regeln dazu kommen oder entfernt werden.
+ Sollte das der Fall sein empfiehlt es sich mit einem Klick auf `Zurücksetzen auf Standard` die Netfilter Regex Regeln neu laden zu lassen. \ No newline at end of file diff --git a/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-netfilter.en.md b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-netfilter.en.md new file mode 100644 index 000000000..321504b03 --- /dev/null +++ b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-netfilter.en.md @@ -0,0 +1,28 @@ +## Change Netfilter Ban Settings + +To change the Netfilter settings in general please navigate to: `Configuration -> Configuration & Details -> Configuration -> Fail2ban parameters`. + +You should now see a familar interface: + +![Netfilter ban settings](../../assets/images/manual-guides/mailcow-netfilter_settings.en.png) + +Here you can set several options regarding the bans itself. +For example the max. Ban time or the max. attempts before a ban is executed. + +## Change Netfilter Regex + +!!! danger + The following area requires at least basic regex knowledge.
+ If you are not sure what you are doing there, we can only advise you not to attempt a reconfiguration. + +In addition to the ban settings, you can also define what exactly should be used from the mailcow container logs to ban a possible attacker. + +To do this, you must first expand the regex field, which will look something like this: + +![Netfilter Regex](../../assets/images/manual-guides/mailcow-netfilter_regex.en.png) + +There you can now create various new filter rules. + +!!! info + As updates progress, it is possible that new Netfilter regex rules will be added or removed.
+ If this is the case, it is recommended to reset the Netfilter regex rules by clicking on `Reset to default`. \ No newline at end of file diff --git a/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tagging.de.md b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-sub_addressing.de.md similarity index 89% rename from docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tagging.de.md rename to docs/manual-guides/mailcow-UI/u_e-mailcow_ui-sub_addressing.de.md index d4e86ae5a..0139c8692 100644 --- a/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tagging.de.md +++ b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-sub_addressing.de.md @@ -1,7 +1,7 @@ Mailbox-Nutzer können ihre Mailadresse wie in "me+facebook@example.org" markieren. Sie können die Tag-Behandlung im **mailcow UI** Panel (für den Benutzer) unter `Mailbox > Einstellungen` kontrollieren. ![mailcow mail tagging settings](../../assets/images/manual-guides/mailcow-tagging.png) -*Tagging ist auch bekannt als 'Sub-Adressierung' (RFC 5233) oder 'Plus-Adressierung'* +*`Sub-Adressierung` (RFC 5233) oder `Plus-Adressierung` auch als Tagging bekannt (nicht zu verwechseln mit [Tags](../u_e-mailcow_ui-tags.md))* ### Verfügbare Aktionen diff --git a/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tagging.en.md b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-sub_addressing.en.md similarity index 89% rename from docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tagging.en.md rename to docs/manual-guides/mailcow-UI/u_e-mailcow_ui-sub_addressing.en.md index dff90422f..c711bf90e 100644 --- a/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tagging.en.md +++ b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-sub_addressing.en.md @@ -1,7 +1,7 @@ Mailbox users can tag their mail address like in `me+facebook@example.org`. They can control the tag handling in the users **mailcow UI** panel under `Mailbox > Settings`. ![mailcow mail tagging settings](../../assets/images/manual-guides/mailcow-tagging.png) -*Tagging is also known as 'sub-addressing' (RFC 5233) or 'plus addressing'* +*`sub-addressing` (RFC 5233) or `plus addressing` also known as tagging (do not mix with [Tags](../u_e-mailcow_ui-tags.md))* ### Available Actions diff --git a/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tags.de.md b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tags.de.md new file mode 100644 index 000000000..31f89ec1f --- /dev/null +++ b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tags.de.md @@ -0,0 +1,25 @@ +!!! info "Hinweis" + Um diese Funktion nutzen zu können ist das Update 2022-05 (oder höher) erforderlich!
+ Sollten Sie das Update nicht installiert haben, denken Sie bitte über ein Update nach.
+ Für weitere Informationen bezüglich dem Update Prozess schauen Sie [hier](../../i_u_m/i_u_m_update.md). + +### Wofür wurden die Tags implementiert? +Mit den Tags ist es deutlich einfacher gezielt nach Domains bzw. Mailboxen zu suchen (wenn diese einen Tag haben). + +### Wo lassen sich die Tags finden? +Die Tags befinden sich in der Domain/Mailbox Sektion der mailcow UI. +Um sie zu sehen, klicken Sie einfach auf das kleine Plus-Symbol auf der linken Seite Ihrer Domain/Mailbox (das folgende Bild zeigt das Domain-Ribbon-Menü): +![Domain/Mailbox Tags Ribbon](../../assets/images/manual-guides/mailcow-domain_tags_ribbon.de.png) + +### Wie kann ich ein Tag hinzufügen/entfernen? +Sie können bei der Erstellung einer neuen Domain/eines neuen Postfachs einfach ein Tag hinzufügen/entfernen. Sie können sie auch hinzufügen/entfernen, wenn Sie Ihre gewünschte Domain/Mailbox bearbeiten. + +Es sieht ähnlich aus wie hier (das folgende Bild zeigt den Bereich zur Bearbeitung der Domäne): + +![Domain/Mailbox Tags](../../assets/images/manual-guides/mailcow-domain_email_tags.de.png) + + +### Wie kann ich nach einem Tag suchen? +Geben Sie einfach den Tag-Namen in die Suchleiste im Bereich Domain/Postfach ein und warten Sie, bis der Vorgang abgeschlossen ist. + +Sie können sogar angeben, ob Sie nur nach Tags suchen möchten. \ No newline at end of file diff --git a/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tags.en.md b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tags.en.md new file mode 100644 index 000000000..3ddd7ad77 --- /dev/null +++ b/docs/manual-guides/mailcow-UI/u_e-mailcow_ui-tags.en.md @@ -0,0 +1,26 @@ +!!! info + You need the mailcow Version 2022-05 at least for this feature.
+ If you don´t have the Version installed please consider a update.
+ For more informations about a mailcow update please take a look at the [Update](../../i_u_m/i_u_m_update.md) section here in the docs. + +### What are Tags designed for? +With the Tags you can easily sort your Domains and Mailboxes by the tags instead of their name. + +### Where are the Tags located? +The Tags are located in the Domain/Mailbox section of the mailcow UI. +To view them simply click on the small plus symbol on the left of your Domain/Mailbox (following picture is showing the domain ribbon menu): +![Domain/Mailbox Tags Ribbon](../../assets/images/manual-guides/mailcow-domain_tags_ribbon.png) + + +### How can i add/remove a Tag? +You can simply add/remove a Tag during the creation of a new Domain/Mailbox. You also can add/remove them if you edit your desired Domain/Mailbox. + +It looks similar to this (following picture showing the domain edit section): + +![Domain/Mailbox Tags](../../assets/images/manual-guides/mailcow-domain_email_tags.png) + + +### How can i search for a tag? +Simply type the Tag Name in the search bar in the Domain/Mailbox Section and wait for it to complete. + +You can even specify if you want to search for tags only. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index e1fcb9067..19a2578d1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -91,9 +91,11 @@ nav: - 'Blacklist / Whitelist': 'manual-guides/mailcow-UI/u_e-mailcow_ui-bl_wl.md' - 'Configuration': 'manual-guides/mailcow-UI/u_e-mailcow_ui-config.md' - 'CSS overrides': 'manual-guides/mailcow-UI/u_e-mailcow_ui-css.md' + - 'Netfilter': 'manual-guides/mailcow-UI/u_e-mailcow_ui-netfilter.md' - 'Pushover': 'manual-guides/mailcow-UI/u_e-mailcow_ui-pushover.md' - 'Spamfilter': 'manual-guides/mailcow-UI/u_e-mailcow_ui-spamfilter.md' - - 'Tagging': 'manual-guides/mailcow-UI/u_e-mailcow_ui-tagging.md' + - 'Sub-addressing': 'manual-guides/mailcow-UI/u_e-mailcow_ui-sub_addressing.md' + - 'Tags (for Domains and Mailboxes)': 'manual-guides/mailcow-UI/u_e-mailcow_ui-tags.md' - 'Temporary email aliases': 'manual-guides/mailcow-UI/u_e-mailcow_ui-spamalias.md' - 'Two-Factor Authentication': 'manual-guides/mailcow-UI/u_e-mailcow_ui-tfa.md' - 'WebAuthn / FIDO2': 'manual-guides/mailcow-UI/u_e-mailcow_ui-fido.md' @@ -214,8 +216,9 @@ plugins: ### Mailcow UI Subsection 'Configuration' : 'Konfiguration' 'CSS overrides' : 'CSS-Überschreibungen' - 'Tagging' : 'Tagging (Markierungen)' + 'Sub-addressing' : 'Sub-Adressierung' 'Temporary email aliases' : 'Temporäre E-Mail-Aliase' + 'Tags (for Domains and Mailboxes)' : 'Tags (für Domains und Mailboxen)' 'Two-Factor Authentication' : 'Zwei-Faktoren-Authentifizierung' ### Postfix Subsection 'Add trusted networks': 'Vertrauenswürdige Netzwerke hinzufügen' @@ -309,10 +312,12 @@ plugins: 'u_e-mailcow_ui-bl_wl.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-bl_wl.en.md' 'u_e-mailcow_ui-config.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-config.en.md' 'u_e-mailcow_ui-css.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-css.en.md' + 'u_e-mailcow_ui-netfilter.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-netfilter.en.md' 'u_e-mailcow_ui-pushover.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-pushover.en.md' 'u_e-mailcow_ui-spamfilter.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-spamfilter.en.md' - 'u_e-mailcow_ui-tagging.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-tagging.en.md' + 'u_e-mailcow_ui-sub_addressing.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-sub_addressing.en.md' 'u_e-mailcow_ui-spamalias.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-spamalias.en.md' + 'u_e-mailcow_ui-tags.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-tags.en.md' 'u_e-mailcow_ui-tfa.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-tfa.en.md' 'u_e-mailcow_ui-fido.md': 'manual-guides/mailcow-UI/u_e-mailcow_ui-fido.en.md' 'u_e-postfix-trust_networks.md': 'manual-guides/Postfix/u_e-postfix-trust_networks.en.md'