diff --git a/docs/index.de.md b/docs/index.de.md index 76d3de0f4..c1f7b07f9 100644 --- a/docs/index.de.md +++ b/docs/index.de.md @@ -1,12 +1,90 @@ -# 🐮 + 🐋 = 💕 +
+ ![mailcow Logo](assets/images/logo.svg){ width="150" } +
+ +# mailcow: dockerized - 🐮 + 🐋 = 💕 +**Die Mailserver-Suite mit dem 'moo'** + +## Was ist mailcow: dockerized? + +!!! question "Frage" + Mailcow, MailCow oder doch mailcow? Wie heißt das Projekt nun genau? + + Richtig: **mailcow**, denn mailcow ist eine eingetragene Wortmarke mit kleinem m :grin: + +mailcow: dockerized ist eine Open-Source Groupware/E-Mail Suite auf Docker Basis. + +Dabei setzt mailcow auf viele bekannte und lang bewertete Komponenten, welche im Zusammenspiel einen Rund um Sorglosen E-Mail Server ergeben. + +Jeder Container repräsentiert eine einzelne Anwendung, die in einem überbrückten (Bridged) Netzwerk verbunden sind. + +- [ACME](https://letsencrypt.org/) (Automatische Generation von Let's Encrypt Zertifikaten) +- [ClamAV](https://www.clamav.net/) (Antiviren Scanner) (optional) +- [Dovecot](https://www.dovecot.org/) (IMAP/POP Server zum Abrufen der E-Mails) +- [MariaDB](https://mariadb.org/) (Datenbank zum Speichern der Nutzer Informationen u.w.) +- [Memcached](https://www.memcached.org/) (Cache für den Webmailer SOGo) +- [Netfilter](https://www.netfilter.org/) (Fail2ban-ähnliche Integration von [@mkuron](https://github.com/mkuron)) +- [Nginx](https://nginx.org/) (Webserver für die mailcow UI) +- [Oletools](https://github.com/decalage2/oletools) über [Olefy](https://github.com/HeinleinSupport/olefy) (Analyse von Office Dokumenten nach Viren, Makros etc.) +- [PHP](https://php.net/) (Programmiersprache der meisten Webbasierten mailcow Aktionen) +- [Postfix](http://www.postfix.org/) (Empfänger/Sender für den E-Mail-Verkehr im Internet) +- [Redis](https://redis.io/) (Speicher für Spaminformationen, DKIM Schlüssel u.w.) +- [Rspamd](https://www.rspamd.com/) (Spamfilter mit automatischem Lernen von Spammails) +- [SOGo](https://sogo.nu/) (Integrierter Webmailer und Cal-/Carddav Schnittstelle) +- [Solr](https://solr.apache.org/) (Voll-Text-Suche für IMAP Verbindungen zum schnellen durchsuchen von E-Mails) (optional) +- [Unbound](https://unbound.net/) (Integrierter DNS-Server zum Verifizieren von DNSSEC u.w) +- Ein Watchdog für die grundlegende Überwachung des Containerstatus innerhalb von mailcow + +Doch das Herzstück bzw. das, was mailcow besonders macht, ist die grafische Weboberfläche, die **mailcow UI**. + +Diese bietet für so gut wie alle Einstellungen einen Platz und erlaubt das bequeme Anlegen von neuen Domains und E-Mail-Adressen mit wenigen Klicks. + +Aber auch andere bzw. kniffligere Themen können in ihr problemlos erledigt werden: + +- [DKIM](http://dkim.org) und [ARC](http://arc-spec.org/) Unterstützung bzw. Generation. +- 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 WebAuthn USB (nur Google Chrome und Derivate), TOTP +- 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 +- Und weitere... + +Die mailcow Daten (wie bspw. E-Mails, Userdaten etc.) werden in **Docker-Volumes** aufbewahrt - geben Sie gut auf diese Volumes acht: + +- clamd-db-vol-1 +- 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 + +!!! warning "Achtung" + Die Mails werden komprimiert und verschlüsselt gespeichert. Das Schlüsselpaar ist in crypt-vol-1 zu finden. Bitte vergessen Sie nicht, dieses und andere Volumes zu sichern. #KeinBackupkeinMitleid +--- ## Unterstützen Sie das mailcow Projekt -Bitte erwägen Sie einen Supportvertrag gegen eine geringe monatliche Gebühr unter [Servercow](https://www.servercow.de/mailcow?#support), um die weitere Entwicklung zu unterstützen. _Wir_ unterstützen _Sie_, während _Sie_ _uns_ unterstützen. :) +Bitte erwägen Sie einen Supportvertrag gegen eine geringe monatliche Gebühr unter [Servercow](https://www.servercow.de/mailcow?#support)[^1], um die weitere Entwicklung zu unterstützen. _Wir_ unterstützen _Sie_, während _Sie_ _uns_ unterstützen. :) -Wenn Sie super toll sind und uns ohne Vertrag unterstützen möchten, können Sie eine SAL-Lizenz erhalten, die Ihre Unterstützung bestätigt (kaufbar als flexible Einmalzahlung) bei [Servercow](https://www.servercow.de/mailcow#sal). +Wenn Sie super toll sind und uns ohne Vertrag unterstützen möchten, können Sie eine SAL (Stay-Awesome License) erhalten, die Ihre Unterstützung bestätigt (kaufbar als flexible Einmalzahlung) bei [Servercow](https://www.servercow.de/mailcow#sal). -## Support erhalten +--- + +## Hilfe gefällig? Es gibt zwei Möglichkeiten, Support für Ihre mailcow-Installation zu erhalten. @@ -16,9 +94,9 @@ Für professionellen und priorisierten kommerziellen Support können Sie ein Bas Darüber hinaus bieten wir auch eine voll ausgestattete und verwaltete [managed mailcow](https://www.servercow.de/mailcow#managed) an. Auf diese Weise kümmern wir uns um alles technische und Sie können Ihr ganzes Mail-Erlebnis auf eine problemlose Weise genießen. -### Community-Unterstützung und Chat +### Community Support 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. +Die 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 Community @ [community.mailcow.email](https://community.mailcow.email) @@ -34,77 +112,26 @@ Nur für **Bug Tracking, Feature Requests und Codebeiträge**: - GitHub @ [mailcow/mailcow-dockerized](https://github.com/mailcow/mailcow-dockerized) -## Demos +--- -Seit September 2022 stellen wir zwei Verschiedene Demos bereit: +## Neugierig? Gleich ausprobieren! -+ **[demo.mailcow.email](https://demo.mailcow.email)** ist die altbekannte Demo, welche sich am **Stabilen Stand** der mailcow orrientiert. -+ **[nightly-demo.mailcow.email](https://nightly-demo.mailcow.email)** ist die neue **Nightly Demo**, welche Testfunktionen beherbergt. (Also insbesondere für alle interessant, die keine Möglichkeit haben sich eine Testinstanz selbst zu erstellen.) +Haben wir Ihr Interesse geweckt? Verschaffen Sie sich in unseren offiziellen **mailcow Demos** einen ersten Überblick über die Funktionalitäten von mailcow und Ihrer mailcow UI! -Die folgenden Anmeldedaten fürs Login funktionieren bei beiden Varianten: +Seit September 2022 stellen wir zwei verschiedene Demos bereit: -- **Administrator**: admin / moohoo -- **Domänen-Administrator**: department / moohoo -- **Mailbox**: demo@440044.xyz / moohoo ++ **[demo.mailcow.email](https://demo.mailcow.email)** ist die altbekannte Demo, welche sich am **Stabilen Stand** der mailcow orrientiert (master Branch auf GitHub). ++ **[nightly-demo.mailcow.email](https://nightly-demo.mailcow.email)** ist die neue **Nightly Demo**, welche Testfunktionen beherbergt. (Also insbesondere für alle interessant, die keine Möglichkeit haben sich eine Testinstanz selbst zu erstellen.) (nightly Branch auf GitHub) -!!! success "Besonderheit" +!!! abstract "Nutzen Sie diese Anmeldedaten für die Demos" + + - **Administrator**: admin / moohoo + - **Domänen-Administrator**: department / moohoo + - **Mailbox**: demo@440044.xyz / moohoo + + *Die Anmeldedaten für die Logins funktionieren bei beiden Varianten* + +!!! success "Immer auf dem neusten Stand" Die Demo Instanzen erhalten die neusten Updates direkt nach Release von GitHub. Vollautomatisch, ohne Downtime! -## Ü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) -- [Unbound](https://unbound.net/) -- Ein Watchdog für die grundlegende Überwachung - -!!! warning "Achtung" - Die Mails werden komprimiert und verschlüsselt gespeichert. Das Schlüsselpaar ist in crypt-vol-1 zu finden. Bitte vergessen Sie nicht, dieses zu sichern. - -**Docker-Volumes** zur Aufbewahrung dynamischer Daten - kümmern Sie sich um sie! - -- clamd-db-vol-1 -- 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 +[^1]: Servercow ist eine Hosting/Support Sparte der The Infrastructure Company GmbH (mailcow Maintainer) \ No newline at end of file diff --git a/docs/index.en.md b/docs/index.en.md index f113f7ce2..c2ae905df 100644 --- a/docs/index.en.md +++ b/docs/index.en.md @@ -1,20 +1,99 @@ -# 🐮 + 🐋 = 💕 +
+ ![mailcow Logo](assets/images/logo.svg){ width="150" } +
-## Help mailcow +# mailcow: dockerized - 🐮 + 🐋 = 💕 +**The mailserver suite with the 'moo'** -Please consider a support contract for a small monthly fee at [Servercow EN](https://www.servercow.de/mailcow?lang=en#support) to support further development. _We_ support _you_ while _you_ support _us_. :) +## What is mailcow: dockerized? -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). +!!! question + Mailcow, MailCow or mailcow? What is the exact name of the project? -## Get support + Correct: **mailcow**, because mailcow is a registered word mark with a small m :grin: + +mailcow: dockerized is an open source groupware/email suite based on docker. + +mailcow relies on many well known and long used components, which in combination result in an all around carefree email server. + +Each container represents a single application, connected in a bridged network. + +- [ACME](https://letsencrypt.org/) (Automatic generation of Let's Encrypt certificates) +- [ClamAV](https://www.clamav.net/) (anti-virus scanner) (optional) +- [Dovecot](https://www.dovecot.org/) (IMAP/POP server for retrieving mail) +- [MariaDB](https://mariadb.org/) (database to store user information, etc.) +- [Memcached](https://www.memcached.org/) (cache for the SOGo webmailer) +- [Netfilter](https://www.netfilter.org/) (Fail2ban-like integration of [@mkuron](https://github.com/mkuron)) +- [Nginx](https://nginx.org/) (Web server for the mailcow UI) +- [Oletools](https://github.com/decalage2/oletools) via [Olefy](https://github.com/HeinleinSupport/olefy) (analyzing office documents for viruses, macros, etc.) +- [PHP](https://php.net/) (programming language for most web-based mailcow actions) +- [Postfix](http://www.postfix.org/) (Receiver/sender for mail traffic on the Internet) +- [Redis](https://redis.io/) (storage for spam information, DKIM keys, etc.) +- [Rspamd](https://www.rspamd.com/) (spam filter with automatic learning of spam mails) +- [SOGo](https://sogo.nu/) (integrated webmailer and cal/carddav interface) +- [Solr](https://solr.apache.org/) (full-text search for IMAP connections for quick email search) (optional) +- [Unbound](https://unbound.net/) (integrated DNS server to check DNSSEC etc.) +- A watchdog for basic monitoring of container health inside mailcow + +But the heart of mailcow is the graphical web interface, the **mailcow UI**. + +It offers a place for almost all settings and allows the comfortable creation of new domains and email addresses with just a few clicks. + +But also other or more tricky tasks can be done in it with ease: + +- [DKIM](http://dkim.org) and [ARC](http://arc-spec.org/) support/generation. +- Black and white lists per domain and per user. +- Spam score management per user (reject spam, flag spam, greylist). +- Allow mailbox users to create temporary spam aliases +- Prepend email tags to subject or move emails to subfolders (per user) +- Allow mailbox users to toggle TLS enforcement for inbound and outbound messages +- Users can reset caches on SOGo ActiveSync devices +- imapsync to periodically migrate or retrieve remote mailboxes +- TFA: Yubikey OTP and WebAuthn USB (Google Chrome and derivatives only), TOTP +- Add whitelist hosts to forward mail to mailcow +- Fail2ban-like integration +- Quarantine system +- Anti-virus scanning including macro scanning in Office documents +- Integrated basic monitoring +- And much more... + +The mailcow data (such as emails, user data, etc.) is stored in **Docker volumes** - take good care of these volumes: + +- clamd-db-vol-1 +- 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 + +!!! warning + The mails are compressed and encrypted. The key pair can be found in crypt-vol-1. Please don't forget to backup this and other volumes. #nobackupnopity + +--- + +## Support the mailcow project + +Please consider a support contract for a small monthly fee at [Servercow](https://www.servercow.de/mailcow?lang=en#support)[^1] 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 (Stay-Awesome License) that confirms your awesomeness (a flexible one-time payment) at [Servercow](https://www.servercow.de/mailcow?lang=en#sal). + +--- + +## Need help? 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). For custom inquiries or questions please contact us at [info@servercow.de](mailto:info@servercow.de) instead. +For professional and prioritized commercial support you can sign a basic support subscription at [Servercow](https://www.servercow.de/mailcow?lang=en#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. +Furthermore we do also provide a fully featured and managed mailcow [here](https://www.servercow.de/mailcow?lang=en#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 @@ -34,77 +113,24 @@ For **bug tracking, feature requests and code contributions** only: - GitHub @ [mailcow/mailcow-dockerized](https://github.com/mailcow/mailcow-dockerized) -## Demos +--- +## Interested? Try it out right away! + +Have we got your interest? Get a first overview of the functionalities of mailcow and your mailcow UI in our official **mailcow demos**! Since September 2022 we´re providing two seperate Demo instances: + **[demo.mailcow.email](https://demo.mailcow.email)** is the classic Demo based on the **stable releases**. + **[nightly-demo.mailcow.email](https://nightly-demo.mailcow.email)** is the new **nightly demo** based on unreleased testing features. (So especially interesting for those who have no possibility to create a test instance themselves.) -Use the following credentials to login on both demos: +!!! abstract "Use these credentials for the demos" + - **Administrator**: admin / moohoo + - **Domain-Administrator**: department / moohoo + - **Mailbox**: demo@440044.xyz / moohoo + + *The login credentials work for both variants*. -- **Administrator**: admin / moohoo -- **Domain-Administrator**: department / moohoo -- **Mailbox**: demo@440044.xyz / moohoo - -!!! success +!!! success "Always up to date" The demo instances get the latest updates directly after releases from GitHub. Fully automatic, without any downtime! -## 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 - -!!! warning - Mails are stored compressed and encrypted. The key pair can be found in crypt-vol-1. Be sure to backup this volume! - -**Docker volumes** to keep dynamic data - take care of them! - -- clamd-db-vol-1 -- 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 +[^1]: Servercow is a hosting/support division of The Infrastructure Company GmbH (mailcow maintainer). \ No newline at end of file