commit 252fef3666826bcb69a2c4824aecba5779eef4aa Author: DerLinkman Date: Sat Jan 29 17:38:32 2022 +0100 Initial commit diff --git a/docs/assets/images/favicon.png b/docs/assets/images/favicon.png new file mode 100644 index 000000000..fe6156078 Binary files /dev/null and b/docs/assets/images/favicon.png differ diff --git a/docs/assets/images/logo.svg b/docs/assets/images/logo.svg new file mode 100644 index 000000000..ea3b2796b --- /dev/null +++ b/docs/assets/images/logo.svg @@ -0,0 +1,179 @@ + + + +image/svg+xml \ No newline at end of file diff --git a/docs/index.de.md b/docs/index.de.md new file mode 100644 index 000000000..95f50885e --- /dev/null +++ b/docs/index.de.md @@ -0,0 +1,96 @@ +# 🐮 + 🐋 = 💕 + +## Hilf dem mailcow Projekt + +Bitte erwägen Sie einen Supportvertrag gegen eine geringe monatliche Gebühr unter [Servercow EN](https://www.servercow.de/mailcow?lang=en#support)/[Servercow DE](https://www.servercow.de/mailcow?#support), um die weitere Entwicklung zu unterstützen. _Wir_ unterstützen _Dich_, während _Du_ _uns_ unterstützt. :) + +Wenn du super toll bist und ohne Vertrag unterstützen möchtest, kannst du eine SAL-Lizenz bekommen, die deine Tollheit bestätigt (eine flexible Einmalzahlung) bei [Servercow EN](https://www.servercow.de/mailcow?lang=en#sal)/[Servercow DE](https://www.servercow.de/mailcow#sal). + +## Support erhalten + +Es gibt zwei Möglichkeiten, Support für Ihre mailcow-Installation zu erhalten. + +### Kommerzieller Support + +Für professionellen und priorisierten kommerziellen Support können Sie ein Basis-Support-Abonnement unter [Servercow EN](https://www.servercow.de/mailcow?lang=en#support)/[Servercow DE](https://www.servercow.de/mailcow#support) abschließen. Für kundenspezifische Anfragen oder Fragen kontaktieren Sie uns stattdessen bitte unter [info@servercow.de](mailto:info@servercow.de). + +Darüber hinaus bieten wir auch eine voll ausgestattete und verwaltete Mailcow [hier](https://www.servercow.de/mailcow#managed) an. Auf diese Weise kümmern wir uns um die technische Magie darunter und Sie können Ihr ganzes Mail-Erlebnis auf eine problemlose Weise genießen. + +### Community-Unterstützung und Chat + +Die andere Alternative ist unser kostenloser Community-Support auf unseren verschiedenen Kanälen unten. Bitte beachten Sie, dass dieser Support von unserer großartigen Community rund um mailcow betrieben wird. Diese Art von Support ist best-effort, freiwillig und es gibt keine Garantie für irgendetwas. + +- Unsere mailcow Gemeinschaft @ [community.mailcow.email](https://community.mailcow.email) + +- Telegram @ [t.me/mailcow](https://t.me/mailcow). + +- Telegram @ [t.me/mailcowOfftopic](https://t.me/mailcowOfftopic). + +Telegram Desktop-Clients sind für [mehrere Plattformen](https://desktop.telegram.org) verfügbar. Sie können den Gruppenverlauf nach Stichworten durchsuchen. + +Nur für **Fehlerverfolgung, Feature Requests und Codebeiträge**: + +- GitHub @ [mailcow/mailcow-dockerized](https://github.com/mailcow/mailcow-dockerized) + +## Demo + +Sie können eine Demo unter [demo.mailcow.email](https://demo.mailcow.email) finden, benutzen Sie die folgenden Anmeldedaten zum Login: + +- **Administrator**: admin / moohoo +- **Domänen-Administrator**: Abteilung / moohoo +- **Postfach**: demo@440044.xyz / moohoo + +## Überblick + +Die integrierte **mailcow UI** ermöglicht administrative Arbeiten auf Ihrer Mailserver-Instanz sowie einen getrennten Domain-Administrator- und Mailbox-Benutzer-Zugriff: + +- [DKIM](http://dkim.org) und [ARC](http://arc-spec.org/) Unterstützung +- Black- und Whitelists pro Domain und pro Benutzer +- Spam-Score-Verwaltung pro Benutzer (Spam ablehnen, Spam markieren, Greylist) +- Erlauben Sie Mailbox-Benutzern, temporäre Spam-Aliase zu erstellen +- Voranstellen von E-Mail-Tags an den Betreff oder Verschieben von E-Mails in Unterordner (pro Benutzer) +- Mailbox-Benutzer können die TLS-Durchsetzung für eingehende und ausgehende Nachrichten umschalten +- Benutzer können die Caches von SOGo ActiveSync-Geräten zurücksetzen +- imapsync, um entfernte Postfächer regelmäßig zu migrieren oder abzurufen +- TFA: Yubikey OTP und U2F USB (nur Google Chrome und Derivate), TOTP +- Hinzufügen von Domänen, Postfächern, Aliasen, Domänenaliasen und SOGo-Ressourcen +- Hinzufügen von Whitelist-Hosts zur Weiterleitung von Mails an mailcow +- Fail2ban-ähnliche Integration +- Quarantäne-System +- Antivirus-Scanning inkl. Makro-Scanning in Office-Dokumenten +- Integrierte Basisüberwachung +- Eine Menge mehr... + +mailcow: dockerized kommt mit mehreren Containern, die in einem überbrückten Netzwerk verbunden sind. +Jeder Container repräsentiert eine einzelne Anwendung. + +- [ACME](https://letsencrypt.org/) +- [ClamAV](https://www.clamav.net/) (optional) +- [Dovecot](https://www.dovecot.org/) +- [MariaDB](https://mariadb.org/) +- [Memcached](https://www.memcached.org/) +- [Netfilter](https://www.netfilter.org/) (Fail2ban-ähnliche Integration von [@mkuron](https://github.com/mkuron)) +- [Nginx](https://nginx.org/) +- [Oletools](https://github.com/decalage2/oletools) über [Olefy](https://github.com/HeinleinSupport/olefy) +- [PHP](https://php.net/) +- [Postfix](http://www.postfix.org/) +- [Redis](https://redis.io/) +- [Rspamd](https://www.rspamd.com/) +- [SOGo](https://sogo.nu/) +- [Solr](https://solr.apache.org/) (optional) +- [Ungebunden](https://unbound.net/) +- Ein Watchdog für die grundlegende Überwachung + +**Docker-Volumes** zur Aufbewahrung dynamischer Daten - kümmern Sie sich um sie! + +- krypt-vol-1 +- mysql-socket-vol-1 +- mysql-vol-1 +- postfix-vol-1 +- redis-vol-1 +- rspamd-vol-1 +- sogo-benutzerdaten-backup-vol-1 +- sogo-web-vol-1 +- solr-vol-1 +- vmail-index-vol-1 +- vmail-vol-1 diff --git a/docs/index.de.md.bak b/docs/index.de.md.bak new file mode 100644 index 000000000..85fca7947 --- /dev/null +++ b/docs/index.de.md.bak @@ -0,0 +1,96 @@ +# 🐮 + 🐋 = 💕 + +## Hilf dem mailcow Projekt + +Bitte erwägen Sie einen Supportvertrag gegen eine geringe monatliche Gebühr unter [Servercow EN](https://www.servercow.de/mailcow?lang=en#support)/[Servercow DE](https://www.servercow.de/mailcow?#support), um die weitere Entwicklung zu unterstützen. _Wir_ unterstützen _Dich_, während _Du_ _uns_ unterstützt. :) + +Wenn du super toll bist und ohne Vertrag unterstützen möchtest, kannst du eine SAL-Lizenz bekommen, die deine Tollheit bestätigt (eine flexible Einmalzahlung) bei [Servercow EN](https://www.servercow.de/mailcow?lang=en#sal)/[Servercow DE](https://www.servercow.de/mailcow#sal). + +## Support erhalten + +Es gibt zwei Möglichkeiten, Support für Ihre mailcow-Installation zu erhalten. + +### Kommerzieller Support + +Für professionellen und priorisierten kommerziellen Support können Sie ein Basis-Support-Abonnement unter [Servercow EN](https://www.servercow.de/mailcow?lang=en#support)/[Servercow DE](https://www.servercow.de/mailcow#support) abschließen. Für kundenspezifische Anfragen oder Fragen kontaktieren Sie uns stattdessen bitte unter [info@servercow.de](mailto:info@servercow.de). + +Darüber hinaus bieten wir auch eine voll ausgestattete und verwaltete Mailcow [hier](https://www.servercow.de/mailcow#managed) an. Auf diese Weise kümmern wir uns um die technische Magie darunter und Sie können Ihr ganzes Mail-Erlebnis auf eine problemlose Weise genießen. + +### Community-Unterstützung und Chat + +Die andere Alternative ist unser kostenloser Community-Support auf unseren verschiedenen Kanälen unten. Bitte beachten Sie, dass dieser Support von unserer großartigen Community rund um mailcow betrieben wird. Diese Art von Support ist best-effort, freiwillig und es gibt keine Garantie für irgendetwas. + +- Unsere mailcow Gemeinschaft @ [community.mailcow.email](https://community.mailcow.email) + +- Telegram @ [t.me/mailcow](https://t.me/mailcow). + +- Telegram @ [t.me/mailcowOfftopic](https://t.me/mailcowOfftopic). + +Telegram Desktop-Clients sind für [mehrere Plattformen](https://desktop.telegram.org) verfügbar. Sie können den Gruppenverlauf nach Stichworten durchsuchen. + +Nur für **Fehlerverfolgung, Feature Requests und Codebeiträge**: + +- GitHub @ [mailcow/mailcow-dockerized](https://github.com/mailcow/mailcow-dockerized) + +## Demo + +Sie können eine Demo unter [demo.mailcow.email](https://demo.mailcow.email) finden, benutzen Sie die folgenden Anmeldedaten zum Login: + +- **Administrator**: admin / moohoo +- **Domänen-Administrator**: Abteilung / moohoo +- **Postfach**: demo@440044.xyz / moohoo + +## Überblick + +Die integrierte **mailcow UI** ermöglicht administrative Arbeiten auf Ihrer Mailserver-Instanz sowie einen getrennten Domain-Administrator- und Mailbox-Benutzer-Zugriff: + +- [DKIM](http://dkim.org) und [ARC](http://arc-spec.org/) Unterstützung +- Black- und Whitelists pro Domain und pro Benutzer +- Spam-Score-Verwaltung pro Benutzer (Spam ablehnen, Spam markieren, Greylist) +- Erlauben Sie Mailbox-Benutzern, temporäre Spam-Aliase zu erstellen +- Voranstellen von E-Mail-Tags an den Betreff oder Verschieben von E-Mails in Unterordner (pro Benutzer) +- Mailbox-Benutzer können die TLS-Durchsetzung für eingehende und ausgehende Nachrichten umschalten +- Benutzer können die Caches von SOGo ActiveSync-Geräten zurücksetzen +- imapsync, um entfernte Postfächer regelmäßig zu migrieren oder abzurufen +- TFA: Yubikey OTP und U2F USB (nur Google Chrome und Derivate), TOTP +- Hinzufügen von Domänen, Postfächern, Aliasen, Domänenaliasen und SOGo-Ressourcen +- Hinzufügen von Whitelist-Hosts zur Weiterleitung von Mails an mailcow +- Fail2ban-ähnliche Integration +- Quarantäne-System +- Antivirus-Scanning inkl. Makro-Scanning in Office-Dokumenten +- Integrierte Basisüberwachung +- Eine Menge mehr... + +mailcow: dockerized kommt mit mehreren Containern, die in einem überbrückten Netzwerk verbunden sind. +Jeder Container repräsentiert eine einzelne Anwendung. + +- [ACME](https://letsencrypt.org/) +- [ClamAV](https://www.clamav.net/) (optional) +- [Dovecot](https://www.dovecot.org/) +- [MariaDB](https://mariadb.org/) +- [Memcached](https://www.memcached.org/) +- [Netfilter](https://www.netfilter.org/) (Fail2ban-aehnliche Integration von [@mkuron](https://github.com/mkuron)) +- [Nginx](https://nginx.org/) +- [Oletools](https://github.com/decalage2/oletools) über [Olefy](https://github.com/HeinleinSupport/olefy) +- [PHP](https://php.net/) +- [Postfix](http://www.postfix.org/) +- [Redis](https://redis.io/) +- [Rspamd](https://www.rspamd.com/) +- [SOGo](https://sogo.nu/) +- [Solr](https://solr.apache.org/) (optional) +- [Ungebunden](https://unbound.net/) +- Ein Watchdog für die grundlegende Überwachung + +**Docker-Volumes** zur Aufbewahrung dynamischer Daten - kümmern Sie sich um sie! + +- krypt-vol-1 +- mysql-socket-vol-1 +- mysql-vol-1 +- postfix-vol-1 +- redis-vol-1 +- rspamd-vol-1 +- sogo-benutzerdaten-backup-vol-1 +- sogo-web-vol-1 +- solr-vol-1 +- vmail-index-vol-1 +- vmail-vol-1 diff --git a/docs/index.en.md b/docs/index.en.md new file mode 100644 index 000000000..6f5a523e4 --- /dev/null +++ b/docs/index.en.md @@ -0,0 +1,96 @@ +# 🐮 + 🐋 = 💕 + +## Help mailcow + +Please consider a support contract for a small monthly fee at [Servercow EN](https://www.servercow.de/mailcow?lang=en#support)/[Servercow DE](https://www.servercow.de/mailcow?#support) to support further development. _We_ support _you_ while _you_ support _us_. :) + +If you are super awesome and would like to support without a contract, you can get a SAL license that confirms your awesomeness (a flexible one-time payment) at [Servercow EN](https://www.servercow.de/mailcow?lang=en#sal)/[Servercow DE](https://www.servercow.de/mailcow#sal). + +## Get support + +There are two ways to achieve support for your mailcow installation. + +### Commercial support + +For professional and prioritized commercial support you can sign a basic support subscription at [Servercow EN](https://www.servercow.de/mailcow?lang=en#support)/[Servercow DE](https://www.servercow.de/mailcow#support). For custom inquiries or questions please contact us at [info@servercow.de](mailto:info@servercow.de) instead. + +Furthermore we do also provide a fully featured and managed mailcow [here](https://www.servercow.de/mailcow#managed). This way we take care about the technical magic underneath and you can enjoy your whole mail experience in a hassle-free way. + +### Community support and chat + +The other alternative is our free community-support on our various channels below. Please notice, that this support is driven by our awesome community around mailcow. This kind of support is best-effort, voluntary and there is no guarantee for anything. + +- Our mailcow community @ [community.mailcow.email](https://community.mailcow.email) + +- Telegram @ [t.me/mailcow](https://t.me/mailcow). + +- Telegram @ [t.me/mailcowOfftopic](https://t.me/mailcowOfftopic). + +Telegram desktop clients are available for [multiple platforms](https://desktop.telegram.org). You can search the groups history for keywords. + +For **bug tracking, feature requests and code contributions** only: + +- GitHub @ [mailcow/mailcow-dockerized](https://github.com/mailcow/mailcow-dockerized) + +## Demo + +You can find a demo at [demo.mailcow.email](https://demo.mailcow.email), use the following credentials to login: + +- **Administrator**: admin / moohoo +- **Domain administrator**: department / moohoo +- **Mailbox**: demo@440044.xyz / moohoo + +## Overview + +The integrated **mailcow UI** allows administrative work on your mail server instance as well as separated domain administrator and mailbox user access: + +- [DKIM](http://dkim.org) and [ARC](http://arc-spec.org/) support +- Black- and whitelists per domain and per user +- Spam score management per-user (reject spam, mark spam, greylist) +- Allow mailbox users to create temporary spam aliases +- Prepend mail tags to subject or move mail to sub folder (per-user) +- Allow mailbox users to toggle incoming and outgoing TLS enforcement +- Allow users to reset SOGo ActiveSync device caches +- imapsync to migrate or pull remote mailboxes regularly +- TFA: Yubikey OTP and U2F USB (Google Chrome and derivatives only), TOTP +- Add domains, mailboxes, aliases, domain aliases and SOGo resources +- Add whitelisted hosts to forward mail to mailcow +- Fail2ban-like integration +- Quarantine system +- Antivirus scanning incl. macro scanning in office documents +- Integrated basic monitoring +- A lot more... + +mailcow: dockerized comes with multiple containers linked in one bridged network. +Each container represents a single application. + +- [ACME](https://letsencrypt.org/) +- [ClamAV](https://www.clamav.net/) (optional) +- [Dovecot](https://www.dovecot.org/) +- [MariaDB](https://mariadb.org/) +- [Memcached](https://www.memcached.org/) +- [Netfilter](https://www.netfilter.org/) (Fail2ban-like integration by [@mkuron](https://github.com/mkuron)) +- [Nginx](https://nginx.org/) +- [Oletools](https://github.com/decalage2/oletools) via [Olefy](https://github.com/HeinleinSupport/olefy) +- [PHP](https://php.net/) +- [Postfix](http://www.postfix.org/) +- [Redis](https://redis.io/) +- [Rspamd](https://www.rspamd.com/) +- [SOGo](https://sogo.nu/) +- [Solr](https://solr.apache.org/) (optional) +- [Unbound](https://unbound.net/) +- A Watchdog to provide basic monitoring + +**Docker volumes** to keep dynamic data - take care of them! + +- crypt-vol-1 +- mysql-socket-vol-1 +- mysql-vol-1 +- postfix-vol-1 +- redis-vol-1 +- rspamd-vol-1 +- sogo-userdata-backup-vol-1 +- sogo-web-vol-1 +- solr-vol-1 +- vmail-index-vol-1 +- vmail-vol-1 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..d6b3de92b --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,20 @@ +site_name: 'mailcow: dockerized documentation' +site_url: https://mailcow.github.io/mailcow-dockerized-docs/ +copyright: "Copyright © 2022 Servercow Team & Community
Based on the work from André Peters" +repo_name: mailcow/mailcow-dockerized +repo_url: https://github.com/mailcow/mailcow-dockerized +edit_uri: ../mailcow-dockerized-docs/edit/master/docs/ +remote_branch: gh-pages + +theme: + name: material + logo: assets/images/logo.svg + favicon: assets/images/favicon.png + +plugins: + - search + - i18n: + default_language: en + languages: + en: English + de: Deutsch