nickslowinski/mailcow-dockerized-docs
1
0
Fork 0
Code Issues Pull-Requests Pakete Projekte Releases Wiki Aktivität

Added Ubuntu 22.04 to supported OS + prerequisite overhaul

Quellcode durchsuchen
Dieser Commit ist enthalten in:
Niklas Meyer 2022-04-27 15:41:08 +02:00
Ursprung 217032d1c8
Commit c065cf280e
3 geänderte Dateien mit 58 neuen und 19 gelöschten Zeilen
Statistiken anzeigen Patch-Datei herunterladen Diff-Datei herunterladen Alle Dateien ausklappen Alle Dateien einklappen

41
docs/prerequisite/prerequisite-system.de.md
Datei anzeigen

@ -1,6 +1,6 @@
Bevor Sie **mailcow: dockerized** ausführen, sollten Sie einige Voraussetzungen überprüfen: Bevor Sie **mailcow: dockerized** ausführen, sollten Sie einige Voraussetzungen überprüfen:
!!! warning !!! warning "Achtung"
Versuchen Sie **nicht**, mailcow auf einem Synology/QNAP-Gerät (jedes NAS), OpenVZ, LXC oder anderen Container-Plattformen zu installieren. KVM, ESX, Hyper-V und andere vollständige Virtualisierungsplattformen werden unterstützt. Versuchen Sie **nicht**, mailcow auf einem Synology/QNAP-Gerät (jedes NAS), OpenVZ, LXC oder anderen Container-Plattformen zu installieren. KVM, ESX, Hyper-V und andere vollständige Virtualisierungsplattformen werden unterstützt.
!!! info !!! info
@ -11,7 +11,8 @@ Bevor Sie **mailcow: dockerized** ausführen, sollten Sie einige Voraussetzungen
## Minimale Systemressourcen ## Minimale Systemressourcen
**OpenVZ, Virtuozzo und LXC werden nicht unterstützt**. !!! failure "Nicht unterstützt"
**OpenVZ, Virtuozzo und LXC**
Bitte stellen Sie sicher, dass Ihr System mindestens über die folgenden Ressourcen verfügt: Bitte stellen Sie sicher, dass Ihr System mindestens über die folgenden Ressourcen verfügt:
@ -22,22 +23,37 @@ Bitte stellen Sie sicher, dass Ihr System mindestens über die folgenden Ressour
| Festplatte | 20 GiB (ohne Emails) | | Festplatte | 20 GiB (ohne Emails) |
| Systemtyp | x86_64 | | Systemtyp | x86_64 |
Wir empfehlen, jede Distribution zu verwenden, die von Docker CE unterstützt wird (siehe https://docs.docker.com/install/). Wir testen auf CentOS 7, Debian 10/11 und Ubuntu 18.04/20.04. ClamAV und Solr können sehr viel Arbeitspeicher verbrauchen. Sie können diese in der `mailcow.conf` durch die Einstellungen `SKIP_CLAMD=y` und `SKIP_SOLR=y` jedoch auch deaktivieren.
ClamAV und Solr können gierig nach RAM sein. Sie können diese in der `mailcow.conf` durch die Einstellungen `SKIP_CLAMD=y` und `SKIP_SOLR=y` deaktivieren. !!! info
Wir sind uns bewusst, dass ein reiner MTA auf 128 MiB RAM laufen kann.
**Info**: Wir sind uns bewusst, dass ein reiner MTA auf 128 MiB RAM laufen kann. mailcow ist eine ausgewachsene und gebrauchsfertige Groupware mit vielen Extras, die das Leben einfacher machen. mailcow kommt mit einem Webserver, Webmailer, ActiveSync (MS), Antivirus, Antispam, Indexierung (Solr), Dokumentenscanner (Oletools), SQL (MariaDB), Cache (Redis), MDA, MTA, verschiedenen Webdiensten etc. mailcow ist eine ausgewachsene und gebrauchsfertige Groupware mit vielen Extras, die das Leben einfacher machen.
Diese kommt mit einem Webserver, Webmailer, ActiveSync (MS), Antivirus, Antispam, Indexierung (Solr), Dokumentenscanner (Oletools), SQL (MariaDB), Cache (Redis), MDA, MTA, verschiedenen Webdiensten etc.
Ein einzelner SOGo-Worker **kann** ~350 MiB RAM belegen, bevor er geleert wird. Je mehr ActiveSync-Verbindungen Sie verwenden möchten, desto mehr RAM wird benötigt. In der Standardkonfiguration werden 20 Arbeiter erzeugt. Ein einzelner SOGo-Worker **kann** ~350 MiB RAM belegen, bevor er geleert wird. Je mehr ActiveSync-Verbindungen Sie verwenden möchten, desto mehr RAM wird benötigt. In der Standardkonfiguration werden 20 Arbeiter erzeugt.
#### Beispiele für die Verwendung #### Beispiele für die RAM Planung
Ein Unternehmen mit 15 Telefonen (EAS aktiviert) und etwa 50 gleichzeitigen IMAP-Verbindungen sollte 16 GiB RAM einplanen. Ein Unternehmen mit 15 Smartphones (EAS aktiviert) und etwa 50 gleichzeitigen IMAP-Verbindungen sollte 16 GiB RAM einplanen.
6 GiB RAM + 1 GiB Swap sind für die meisten privaten Installationen ausreichend, während 8 GiB RAM für ~5 bis 10 Benutzer empfohlen werden. 6 GiB RAM + 1 GiB Swap sind für die meisten privaten Installationen ausreichend, während 8 GiB RAM für ~5 bis 10 Benutzer empfohlen werden.
Im Rahmen unseres Supports können wir Ihnen bei der korrekten Planung Ihres Setups helfen. Im Rahmen unseres Supports können wir Ihnen bei der korrekten Planung Ihres Setups helfen.
### Unterstützte Betriebssysteme
Wir empfehlen, jede Distribution zu verwenden, die von Docker CE unterstützt wird (siehe https://docs.docker.com/install/).
Die folgende Tabelle enthält alle von uns offiziell unterstützten und getesteten Betriebssysteme:
| Betriebssystem | Status |
| ----------------------- | ------------------------------------------------ |
| Centos 7 | ✅ |
| Debian 10, 11 | ✅ |
| Ubuntu 18.04, 20.04, 22.04 | ✅ |
**Andere (nicht genannte Betriebssysteme) können auch funktionieren, sind jedoch nicht offiziell getestet worden.**
## Firewall & Ports ## Firewall & Ports
Bitte überprüfen Sie, ob alle Standard-Ports von mailcow offen sind und nicht von anderen Anwendungen genutzt werden: Bitte überprüfen Sie, ob alle Standard-Ports von mailcow offen sind und nicht von anderen Anwendungen genutzt werden:
@ -48,9 +64,12 @@ ss -tlpn | grep -E -w '25|80|110|143|443|465|587|993|995|4190'
netstat -tulpn | grep -E -w '25|80|110|143|443|465|587|993|995|4190' netstat -tulpn | grep -E -w '25|80|110|143|443|465|587|993|995|4190'
``` ```
!!! Warnung !!! danger "Vorsicht"
Es gibt einige Probleme mit dem Betrieb von mailcow auf einem Firewalld/ufw aktivierten System. Sie sollten es deaktivieren (wenn möglich) und stattdessen Ihren Regelsatz in die DOCKER-USER-Kette verschieben, die nicht durch einen Neustart des Docker-Dienstes gelöscht wird. Siehe [diese (blog.donnex.net)](https://blog.donnex.net/docker-and-iptables-filtering/) oder [diese (unrouted.io)](https://unrouted.io/2017/08/15/docker-firewall/) Anleitung für Informationen darüber, wie man iptables-persistent mit der DOCKER-USER Kette benutzt. Es gibt einige Probleme mit dem Betrieb von mailcow auf einem Firewalld/ufw aktivierten System. <br>
Da mailcow im Docker-Modus läuft, haben INPUT-Regeln keinen Effekt auf die Beschränkung des Zugriffs auf mailcow. Verwenden Sie stattdessen die FORWARD-Kette. Sie sollten es deaktivieren (wenn möglich) und stattdessen Ihren Regelsatz in die DOCKER-USER-Kette verschieben, die nicht durch einen Neustart des Docker-Dienstes gelöscht wird. <br>
Siehe [diese (blog.donnex.net)](https://blog.donnex.net/docker-and-iptables-filtering/) oder [diese (unrouted.io)](https://unrouted.io/2017/08/15/docker-firewall/) Anleitung für Informationen darüber, wie man iptables-persistent mit der DOCKER-USER Kette benutzt. <br>
Da mailcow im Docker-Modus läuft, haben INPUT-Regeln keinen Effekt auf die Beschränkung des Zugriffs auf mailcow. <br>
Verwenden Sie stattdessen die FORWARD-Kette.
Wenn dieser Befehl irgendwelche Ergebnisse liefert, entfernen oder stoppen Sie bitte die Anwendung, die auf diesem Port läuft. Sie können mailcows Ports auch über die Konfigurationsdatei `mailcow.conf` anpassen. Wenn dieser Befehl irgendwelche Ergebnisse liefert, entfernen oder stoppen Sie bitte die Anwendung, die auf diesem Port läuft. Sie können mailcows Ports auch über die Konfigurationsdatei `mailcow.conf` anpassen.

32
docs/prerequisite/prerequisite-system.en.md
Datei anzeigen

@ -11,7 +11,8 @@ Before you run **mailcow: dockerized**, there are a few requirements that you sh
## Minimum System Resources ## Minimum System Resources
**OpenVZ, Virtuozzo and LXC are not supported**. !!! failure "Not supported"
**OpenVZ, Virtuozzo and LXC**
Please make sure that your system has at least the following resources: Please make sure that your system has at least the following resources:
@ -22,15 +23,14 @@ Please make sure that your system has at least the following resources:
| Disk | 20 GiB (without emails) | | Disk | 20 GiB (without emails) |
| System Type | x86_64 | | System Type | x86_64 |
We recommend using any distribution listed as supported by Docker CE (check https://docs.docker.com/install/). We test on CentOS 7, Debian 10/11 and Ubuntu 18.04/20.04.
ClamAV and Solr can be greedy with RAM. You may disable them in `mailcow.conf` by settings `SKIP_CLAMD=y` and `SKIP_SOLR=y`. ClamAV and Solr can be greedy with RAM. You may disable them in `mailcow.conf` by settings `SKIP_CLAMD=y` and `SKIP_SOLR=y`.
**Info**: We are aware that a pure MTA can run on 128 MiB RAM. mailcow is a full-grown and ready-to-use groupware with many extras making life easier. mailcow comes with a webserver, webmailer, ActiveSync (MS), antivirus, antispam, indexing (Solr), document scanner (Oletools), SQL (MariaDB), Cache (Redis), MDA, MTA, various web services etc. !!! info
We are aware that a pure MTA can run on 128 MiB RAM. mailcow is a full-grown and ready-to-use groupware with many extras making life easier. mailcow comes with a webserver, webmailer, ActiveSync (MS), antivirus, antispam, indexing (Solr), document scanner (Oletools), SQL (MariaDB), Cache (Redis), MDA, MTA, various web services etc.
A single SOGo worker **can** acquire ~350 MiB RAM before it gets purged. The more ActiveSync connections you plan to use, the more RAM you will need. A default configuration spawns 20 workers. A single SOGo worker **can** acquire ~350 MiB RAM before it gets purged. The more ActiveSync connections you plan to use, the more RAM you will need. A default configuration spawns 20 workers.
#### Usage examples #### RAM usage examples
A company with 15 phones (EAS enabled) and about 50 concurrent IMAP connections should plan 16 GiB RAM. A company with 15 phones (EAS enabled) and about 50 concurrent IMAP connections should plan 16 GiB RAM.
@ -38,6 +38,19 @@ A company with 15 phones (EAS enabled) and about 50 concurrent IMAP connections
We can help to correctly plan your setup as part of our support. We can help to correctly plan your setup as part of our support.
### Supported OS
We recommend using any distribution listed as supported by Docker CE (check https://docs.docker.com/install/).
See the following table for the official supported and tested destributions:
| OS | Status |
| ----------------------- | ------------------------------------------------ |
| Centos 7 | ✅ |
| Debian 10, 11 | ✅ |
| Ubuntu 18.04, 20.04, 22.04 | ✅ |
**Other Distributions may work as well but weren´t tested by us!**
## Firewall & Ports ## Firewall & Ports
Please check if any of mailcow's standard ports are open and not in use by other applications: Please check if any of mailcow's standard ports are open and not in use by other applications:
@ -48,9 +61,12 @@ ss -tlpn | grep -E -w '25|80|110|143|443|465|587|993|995|4190'
netstat -tulpn | grep -E -w '25|80|110|143|443|465|587|993|995|4190' netstat -tulpn | grep -E -w '25|80|110|143|443|465|587|993|995|4190'
``` ```
!!! warning !!! danger
There are several problems with running mailcow on a firewalld/ufw enabled system. You should disable it (if possible) and move your ruleset to the DOCKER-USER chain, which is not cleared by a Docker service restart, instead. See [this (blog.donnex.net)](https://blog.donnex.net/docker-and-iptables-filtering/) or [this (unrouted.io)](https://unrouted.io/2017/08/15/docker-firewall/) guide for information about how to use iptables-persistent with the DOCKER-USER chain. There are several problems with running mailcow on a firewalld/ufw enabled system. <br>
As mailcow runs dockerized, INPUT rules have no effect on restricting access to mailcow. Use the FORWARD chain instead. You should disable it (if possible) and move your ruleset to the DOCKER-USER chain, which is not cleared by a Docker service restart, instead. <br>
See [this (blog.donnex.net)](https://blog.donnex.net/docker-and-iptables-filtering/) or [this (unrouted.io)](https://unrouted.io/2017/08/15/docker-firewall/) guide for information about how to use iptables-persistent with the DOCKER-USER chain.<br>
As mailcow runs dockerized, INPUT rules have no effect on restricting access to mailcow. <br>
Use the FORWARD chain instead.<br>
If this command returns any results please remove or stop the application running on that port. You may also adjust mailcows ports via the `mailcow.conf` configuration file. If this command returns any results please remove or stop the application running on that port. You may also adjust mailcows ports via the `mailcow.conf` configuration file.

4
mkdocs.yml
Datei anzeigen

@ -22,6 +22,7 @@ theme:
features: features:
- navigation.top - navigation.top
- navigation.tracking - navigation.tracking
markdown_extensions: markdown_extensions:
- attr_list - attr_list
- admonition - admonition
@ -30,6 +31,9 @@ markdown_extensions:
- pymdownx.magiclink - pymdownx.magiclink
- pymdownx.tasklist: - pymdownx.tasklist:
custom_checkbox: true custom_checkbox: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.mark - pymdownx.mark
- pymdownx.tilde - pymdownx.tilde
- pymdownx.extra - pymdownx.extra