From e28b5b8cac40f9e6332fc653b2c6622fcfa158de Mon Sep 17 00:00:00 2001 From: DerLinkman Date: Mon, 9 Jan 2023 15:44:30 +0100 Subject: [PATCH] New Pages with Docker Compose Switcher --- docs/assets/stylesheets/extra.css | 7 +- .../Dovecot/u_e-dovecot-vmail-volume.de.md | 2 +- docs/models/model-passwd.de.md | 14 +- docs/models/model-passwd.en.md | 14 +- .../firststeps-disable_ipv6.de.md | 46 +++-- .../firststeps-disable_ipv6.en.md | 45 +++-- .../firststeps-dmarc_reporting.de.md | 159 ++++++++++++++---- .../firststeps-dmarc_reporting.en.md | 130 +++++++++++--- .../firststeps-ip_bindings.de.md | 32 +++- .../firststeps-ip_bindings.en.md | 32 +++- .../firststeps-logging.de.md | 38 ++++- .../firststeps-logging.en.md | 30 +++- .../debug-admin_login_sogo.de.md | 15 +- .../debug-admin_login_sogo.en.md | 15 +- .../debug-attach_service.de.md | 46 +++-- .../debug-attach_service.en.md | 45 +++-- docs/troubleshooting/debug-logs.de.md | 30 +++- overrides/main.html | 9 +- 18 files changed, 586 insertions(+), 123 deletions(-) diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css index 11a533573..cf96f95f3 100644 --- a/docs/assets/stylesheets/extra.css +++ b/docs/assets/stylesheets/extra.css @@ -59,4 +59,9 @@ code { :root { --md-code-font: "Source Code Pro"; - } \ No newline at end of file + } + +[data-md-color-scheme="slate"] { + + --md-typeset-a-color: #6390e5; +} \ No newline at end of file diff --git a/docs/manual-guides/Dovecot/u_e-dovecot-vmail-volume.de.md b/docs/manual-guides/Dovecot/u_e-dovecot-vmail-volume.de.md index 4b908f73d..564ce5796 100644 --- a/docs/manual-guides/Dovecot/u_e-dovecot-vmail-volume.de.md +++ b/docs/manual-guides/Dovecot/u_e-dovecot-vmail-volume.de.md @@ -3,7 +3,7 @@ !!! warning Neuere Docker-Versionen scheinen sich über bestehende Volumes zu beschweren. Man kann dies vorübergehend beheben, indem man das bestehende Volume entfernt und mailcow mit der Override-Datei startet. Aber es scheint nach einem Neustart problematisch zu sein (muss bestätigt werden). -Ein einfacher, schmutziger, aber stabiler Workaround ist es, mailcow zu stoppen (`docker compose down`), `/var/lib/docker/volumes/mailcowdockerized_vmail-vol-1/_data` zu entfernen und einen neuen Link zu Ihrem entfernten Dateisystem zu erstellen, zum Beispiel: +Ein einfacher, schmutziger, aber stabiler Workaround ist es, mailcow zu stoppen, `/var/lib/docker/volumes/mailcowdockerized_vmail-vol-1/_data` zu entfernen und einen neuen Link zu Ihrem entfernten Dateisystem zu erstellen, zum Beispiel: ``` mv /var/lib/docker/volumes/mailcowdockerized_vmail-vol-1/_data /var/lib/docker/volumes/mailcowdockerized_vmail-vol-1/_data_backup diff --git a/docs/models/model-passwd.de.md b/docs/models/model-passwd.de.md index a44b962d8..25f18212d 100644 --- a/docs/models/model-passwd.de.md +++ b/docs/models/model-passwd.de.md @@ -46,4 +46,16 @@ Der Wert von `MAILCOW_PASS_SCHEME` wird _immer_ verwendet, um neue Passwörter z > 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 +Eine "Ansicht" muss aktualisiert werden. Sie können dies durch einen Neustart von sogo-mailcow auslösen: + +=== "docker compose (Plugin)" + + ``` bash + docker compose restart sogo-mailcow + ``` + +=== "docker-compose (Standalone)" + + ``` bash + 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 index 5885b723c..fd13148d7 100644 --- a/docs/models/model-passwd.en.md +++ b/docs/models/model-passwd.en.md @@ -46,4 +46,16 @@ The value of `MAILCOW_PASS_SCHEME` will _always_ be used to encrypt new password > 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 +A "view" needs to be updated. You can trigger this by restarting sogo-mailcow: + +=== "docker compose (Plugin)" + + ``` bash + docker compose restart sogo-mailcow + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose restart sogo-mailcow + ``` \ No newline at end of file diff --git a/docs/post_installation/firststeps-disable_ipv6.de.md b/docs/post_installation/firststeps-disable_ipv6.de.md index 10088e615..e469025cc 100644 --- a/docs/post_installation/firststeps-disable_ipv6.de.md +++ b/docs/post_installation/firststeps-disable_ipv6.de.md @@ -45,10 +45,20 @@ services: Damit diese Änderungen wirksam werden, müssen Sie den Stack vollständig stoppen und dann neu starten, damit Container und Netzwerke neu erstellt werden: -``` -docker compose down -docker compose up -d -``` + +=== "docker compose (Plugin)" + + ``` bash + docker compose down + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose down + docker-compose up -d + ``` **3.** Deaktivieren Sie IPv6 in unbound-mailcow @@ -63,9 +73,17 @@ Server: unbound neu starten: -``` -docker compose restart unbound-mailcow -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose restart unbound-mailcow + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose restart unbound-mailcow + ``` **4.** Deaktivieren Sie IPv6 in postfix-mailcow @@ -78,9 +96,17 @@ inet_protocols = ipv4 Starten Sie Postfix neu: -``` -docker compose restart postfix-mailcow -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose restart postfix-mailcow + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose restart postfix-mailcow + ``` **5.** Wenn im Docker Daemon IPv6 komplett deaktiviert ist: diff --git a/docs/post_installation/firststeps-disable_ipv6.en.md b/docs/post_installation/firststeps-disable_ipv6.en.md index 7313bfd06..26c89a8db 100644 --- a/docs/post_installation/firststeps-disable_ipv6.en.md +++ b/docs/post_installation/firststeps-disable_ipv6.en.md @@ -45,10 +45,19 @@ services: For these changes to be effective, you need to fully stop and then restart the stack, so containers and networks are recreated: -``` -docker compose down -docker compose up -d -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose down + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose down + docker-compose up -d + ``` **3.** Disable IPv6 in unbound-mailcow @@ -63,9 +72,17 @@ server: Restart Unbound: -``` -docker compose restart unbound-mailcow -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose restart unbound-mailcow + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose restart unbound-mailcow + ``` **4.** Disable IPv6 in postfix-mailcow @@ -78,9 +95,17 @@ inet_protocols = ipv4 Restart Postfix: -``` -docker compose restart postfix-mailcow -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose restart postfix-mailcow + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose restart postfix-mailcow + ``` **5.** If your docker daemon completly disabled IPv6: diff --git a/docs/post_installation/firststeps-dmarc_reporting.de.md b/docs/post_installation/firststeps-dmarc_reporting.de.md index 5ba98fb61..78adec51f 100644 --- a/docs/post_installation/firststeps-dmarc_reporting.de.md +++ b/docs/post_installation/firststeps-dmarc_reporting.de.md @@ -52,7 +52,19 @@ services: - rspamd-mailcow ``` -Starte `docker compose up -d` +Starten Sie den mailcow Stack mit: + +=== "docker compose (Plugin)" + + ``` bash + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose up -d + ``` ## Senden Sie eine Kopie der Berichte an sich selbst @@ -77,34 +89,74 @@ Dies kann nützlich sein, wenn Sie... Prüfen Sie, wann der Berichtsplan zuletzt ausgeführt wurde: -``` -docker compose exec rspamd-mailcow date -r /var/lib/rspamd/dmarc_reports_last_log -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec rspamd-mailcow date -r /var/lib/rspamd/dmarc_reports_last_log + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec rspamd-mailcow date -r /var/lib/rspamd/dmarc_reports_last_log + ``` Sehen Sie sich die letzte Berichtsausgabe an: -``` -docker compose exec rspamd-mailcow cat /var/lib/rspamd/dmarc_reports_last_log -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec rspamd-mailcow cat /var/lib/rspamd/dmarc_reports_last_log + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec rspamd-mailcow cat /var/lib/rspamd/dmarc_reports_last_log + ``` Manuelles Auslösen eines DMARC-Berichts: -``` -docker compose exec rspamd-mailcow rspamadm dmarc_report -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec rspamd-mailcow rspamadm dmarc_report + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec rspamd-mailcow rspamadm dmarc_report + ``` Bestätigen Sie, dass Rspamd Daten in Redis aufgezeichnet hat: -Ändern Sie `20220428` in ein anderes interessantes Datum zum schauen. +Ändern Sie `20220428` in Ihr gewünschtes Datum zum überprüfen. -``` -docker compose exec redis-mailcow redis-cli SMEMBERS "dmarc_idx;20220428" -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec redis-mailcow redis-cli SMEMBERS "dmarc_idx;20220428" + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec redis-mailcow redis-cli SMEMBERS "dmarc_idx;20220428" + ``` Nehmen Sie eine der Zeilen aus der Ausgabe, die Sie interessiert, und fordern Sie sie an, z. B.: -``` -docker compose exec redis-mailcow redis-cli ZRANGE "dmarc_rpt;microsoft.com;mailto:d@rua.agari.com;20220428" 0 49 -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec redis-mailcow redis-cli ZRANGE "dmarc_rpt;microsoft.com;mailto:d@rua.agari.com;20220428" 0 49 + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec redis-mailcow redis-cli ZRANGE "dmarc_rpt;microsoft.com;mailto:d@rua.agari.com;20220428" 0 49 + ``` ## Ändern Sie die Häufigkeit der DMARC-Berichte @@ -118,28 +170,51 @@ Der Ofelia-Zeitplan hat die gleiche Implementierung wie `cron` in Go, die unters Um den Zeitplan zu ändern: 1. `docker-compose.override.yml` bearbeiten: + ``` + version: '2.1' -``` -version: '2.1' + services: + rspamd-mailcow: + environment: + - MASTER=${MASTER:-y} + labels: + ofelia.enabled: "true" + ofelia.job-exec.rspamd_dmarc_reporting_yesterday.schedule: "0 5 0 * * *" + ofelia.job-exec.rspamd_dmarc_reporting_yesterday.command: "/bin/bash -c \"[[ $${MASTER} == y ]] && /usr/bin/rspamadm dmarc_report $(date --date yesterday '+%Y%m%d') > /var/lib/rspamd/dmarc_reports_last_log 2>&1 || exit 0\"" + ofelia.job-exec.rspamd_dmarc_reporting_today.schedule: "@every 12h" + ofelia.job-exec.rspamd_dmarc_reporting_today.command: "/bin/bash -c \"[[ $${MASTER} == y ]] && /usr/bin/rspamadm dmarc_report $(date '+%Y%m%d') > /var/lib/rspamd/dmarc_reports_last_log 2>&1 || exit 0\"" + ofelia-mailcow: + depends_on: + - rspamd-mailcow + ``` -services: - rspamd-mailcow: - environment: - - MASTER=${MASTER:-y} - labels: - ofelia.enabled: "true" - ofelia.job-exec.rspamd_dmarc_reporting_yesterday.schedule: "0 5 0 * * *" - ofelia.job-exec.rspamd_dmarc_reporting_yesterday.command: "/bin/bash -c \"[[ $${MASTER} == y ]] && /usr/bin/rspamadm dmarc_report $(date --date yesterday '+%Y%m%d') > /var/lib/rspamd/dmarc_reports_last_log 2>&1 || exit 0\"" - ofelia.job-exec.rspamd_dmarc_reporting_today.schedule: "@every 12h" - ofelia.job-exec.rspamd_dmarc_reporting_today.command: "/bin/bash -c \"[[ $${MASTER} == y ]] && /usr/bin/rspamadm dmarc_report $(date '+%Y%m%d') > /var/lib/rspamd/dmarc_reports_last_log 2>&1 || exit 0\"" - ofelia-mailcow: - depends_on: - - rspamd-mailcow -``` +2. Starten Sie die betroffenen Container neu: -2. Führen Sie `docker compose up -d` aus. + === "docker compose (Plugin)" -3. Führen Sie `docker compose restart ofelia-mailcow` aus + ``` bash + docker compose up -d + ``` + + === "docker-compose (Standalone)" + + ``` bash + docker-compose up -d + ``` + +3. Führen Sie einen Neustart nur von Ofelia aus: + + === "docker compose (Plugin)" + + ``` bash + docker compose restart ofelia-mailcow + ``` + + === "docker-compose (Standalone)" + + ``` bash + docker-compose restart ofelia-mailcow + ``` ## DMARC-Berichterstattung deaktivieren @@ -149,4 +224,16 @@ Zum Deaktivieren der Berichterstattung: 2. Machen Sie Änderungen in `docker-compose.override.yml` an `rspamd-mailcow` und `ofelia-mailcow` rückgängig -3. Führen Sie `docker compose up -d` aus +3. Starten Sie die betroffenen Container neu: + + === "docker compose (Plugin)" + + ``` bash + docker compose up -d + ``` + + === "docker-compose (Standalone)" + + ``` bash + docker-compose up -d + ``` diff --git a/docs/post_installation/firststeps-dmarc_reporting.en.md b/docs/post_installation/firststeps-dmarc_reporting.en.md index 2643a3ecb..d84e50af5 100644 --- a/docs/post_installation/firststeps-dmarc_reporting.en.md +++ b/docs/post_installation/firststeps-dmarc_reporting.en.md @@ -52,7 +52,18 @@ services: - rspamd-mailcow ``` -Run `docker compose up -d` +Start the mailcow stack with: +=== "docker compose (Plugin)" + + ``` bash + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose up -d + ``` ## Send a copy reports to yourself @@ -77,32 +88,73 @@ This can be useful if you... Check when the report schedule last ran: -``` -docker compose exec rspamd-mailcow date -r /var/lib/rspamd/dmarc_reports_last_log -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec rspamd-mailcow date -r /var/lib/rspamd/dmarc_reports_last_log + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec rspamd-mailcow date -r /var/lib/rspamd/dmarc_reports_last_log + ``` See the latest report output: -``` -docker compose exec rspamd-mailcow cat /var/lib/rspamd/dmarc_reports_last_log -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec rspamd-mailcow cat /var/lib/rspamd/dmarc_reports_last_log + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec rspamd-mailcow cat /var/lib/rspamd/dmarc_reports_last_log + ``` Manually trigger a DMARC report: -``` -docker compose exec rspamd-mailcow rspamadm dmarc_report -``` +=== "docker compose (Plugin)" -Validate that Rspamd has recorded data in Redis: -Change `20220428` to date which you interested in. + ``` bash + docker compose exec rspamd-mailcow rspamadm dmarc_report + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec rspamd-mailcow rspamadm dmarc_report + ``` + +Validate that Rspamd has recorded data in Redis: Change `20220428` to date which you interested in. + +=== "docker compose (Plugin)" + + ``` bash + docker compose exec redis-mailcow redis-cli SMEMBERS "dmarc_idx;20220428" + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec redis-mailcow redis-cli SMEMBERS "dmarc_idx;20220428" + ``` -``` -docker compose exec redis-mailcow redis-cli SMEMBERS "dmarc_idx;20220428" -``` Take one of the lines from output you interested in and request it, f.e.: -``` -docker compose exec redis-mailcow redis-cli ZRANGE "dmarc_rpt;microsoft.com;mailto:d@rua.agari.com;20220428" 0 49 -``` + +=== "docker compose (Plugin)" + + ``` bash + docker compose exec redis-mailcow redis-cli ZRANGE "dmarc_rpt;microsoft.com;mailto:d@rua.agari.com;20220428" 0 49 + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec redis-mailcow redis-cli ZRANGE "dmarc_rpt;microsoft.com;mailto:d@rua.agari.com;20220428" 0 49 + ``` ## Change DMARC reporting frequency @@ -134,9 +186,33 @@ services: - rspamd-mailcow ``` -2. Run `docker compose up -d` +2. Restart the desired containers with: -3. Run `docker compose restart ofelia-mailcow` + === "docker compose (Plugin)" + + ``` bash + docker compose up -d + ``` + + === "docker-compose (Standalone)" + + ``` bash + docker-compose up -d + ``` + +3. Restart the ofelia container only: + + === "docker compose (Plugin)" + + ``` bash + docker compose restart ofelia-mailcow + ``` + + === "docker-compose (Standalone)" + + ``` bash + docker-compose restart ofelia-mailcow + ``` ## Disable DMARC Reporting @@ -146,4 +222,16 @@ To disable reporting: 2. Revert changes done in `docker-compose.override.yml` to `rspamd-mailcow` and `ofelia-mailcow` -3. Run `docker compose up -d` +3. Restart the desired containers with: + + === "docker compose (Plugin)" + + ``` bash + docker compose up -d + ``` + + === "docker-compose (Standalone)" + + ``` bash + docker-compose up -d + ``` diff --git a/docs/post_installation/firststeps-ip_bindings.de.md b/docs/post_installation/firststeps-ip_bindings.de.md index 1e53919f6..33345d562 100644 --- a/docs/post_installation/firststeps-ip_bindings.de.md +++ b/docs/post_installation/firststeps-ip_bindings.de.md @@ -33,7 +33,21 @@ SQL_PORT=127.0.0.1:13306 SOLR_PORT=127.0.0.1:18983 ``` -Um Ihre Änderungen zu übernehmen, führen Sie `docker compose down` gefolgt von `docker compose up -d` aus. +Um Ihre Änderungen zu übernehmen, führen Sie folgende Befehle aus: + +=== "docker compose (Plugin)" + + ``` bash + docker compose down + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose down + docker-compose up -d + ``` ## IPv6-Binding @@ -69,4 +83,18 @@ services: - '[2001:db8:dead:beef::123]:443:443' ``` -Um Ihre Änderungen zu übernehmen, führen Sie `docker compose down` gefolgt von `docker compose up -d` aus. \ No newline at end of file +Um Ihre Änderungen zu übernehmen, führen Sie folgendes aus: + +=== "docker compose (Plugin)" + + ``` bash + docker compose down + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose down + docker-compose up -d + ``` \ No newline at end of file diff --git a/docs/post_installation/firststeps-ip_bindings.en.md b/docs/post_installation/firststeps-ip_bindings.en.md index df63ea98b..112d234b2 100644 --- a/docs/post_installation/firststeps-ip_bindings.en.md +++ b/docs/post_installation/firststeps-ip_bindings.en.md @@ -33,7 +33,21 @@ SQL_PORT=127.0.0.1:13306 SOLR_PORT=127.0.0.1:18983 ``` -To apply your changes, run `docker compose down` followed by `docker compose up -d`. +To apply your changes, run: + +=== "docker compose (Plugin)" + + ``` bash + docker compose down + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose down + docker-compose up -d + ``` ## IPv6 binding @@ -69,4 +83,18 @@ services: - '[2001:db8:dead:beef::123]:443:443' ``` -To apply your changes, run `docker compose down` followed by `docker compose up -d`. \ No newline at end of file +To apply your changes, run the commands below: + +=== "docker compose (Plugin)" + + ``` bash + docker compose down + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose down + docker-compose up -d + ``` \ No newline at end of file diff --git a/docs/post_installation/firststeps-logging.de.md b/docs/post_installation/firststeps-logging.de.md index a94724d6d..b9e4ea537 100644 --- a/docs/post_installation/firststeps-logging.de.md +++ b/docs/post_installation/firststeps-logging.de.md @@ -1,7 +1,19 @@ Das Logging in mailcow: dockerized besteht aus mehreren Stufen, ist aber immerhin wesentlich flexibler und einfacher in einen Logging-Daemon zu integrieren als bisher. In Docker schreibt die containerisierte Anwendung (PID 1) ihre Ausgabe auf stdout. Für echte Ein-Anwendungs-Container funktioniert das sehr gut. -Führen Sie `docker compose logs --help` aus, um mehr zu erfahren. +Führen Sie folgenden Befehl aus, um mehr zu erfahren: + +=== "docker compose (Plugin)" + + ``` bash + docker compose logs --help + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose logs --help + ``` Einige Container protokollieren oder streamen an mehrere Ziele. @@ -96,12 +108,12 @@ Wenn Sie den Logging-Treiber **global** ändern wollen, editieren Sie die Konfig ``` { -... +[...] "log-driver": "gelf", "log-opts": { "gelf-address": "udp://graylog:12201" } -... +[...] } ``` @@ -109,16 +121,30 @@ Für Syslog: ``` { -... +[...] "log-driver": "syslog", "log-opts": { "syslog-address": "udp://1.2.3.4:514" } -... +[...] } ``` -Starten Sie den Docker-Daemon neu und führen Sie `docker compose down && docker compose up -d` aus, um die Container mit dem neuen Protokollierungstreiber neu zu erstellen. +Starten Sie den Docker-Daemon neu und führen Sie die folgenden Befehle aus, um die Container mit dem neuen Protokollierungstreiber neu zu erstellen: + +=== "docker compose (Plugin)" + + ``` bash + docker compose down + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose down + docker-compose up -d + ``` ### Log rotation diff --git a/docs/post_installation/firststeps-logging.en.md b/docs/post_installation/firststeps-logging.en.md index b02812cf4..af0398fa7 100644 --- a/docs/post_installation/firststeps-logging.en.md +++ b/docs/post_installation/firststeps-logging.en.md @@ -1,7 +1,19 @@ Logging in mailcow: dockerized consists of multiple stages, but is, after all, much more flexible and easier to integrate into a logging daemon than before. In Docker the containerized application (PID 1) writes its output to stdout. For real one-application containers this works just fine. -Run `docker compose logs --help` to learn more. +Run the command below to learn more: + +=== "docker compose (Plugin)" + + ``` bash + docker compose logs --help + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose logs --help + ``` Some containers log or stream to multiple destinations. @@ -117,7 +129,21 @@ For Syslog: } ``` -Restart the Docker daemon and run `docker compose down && docker compose up -d` to recreate the containers with the new logging driver. +Restart the Docker daemon and run the commands below to recreate the containers with the new logging driver: + +=== "docker compose (Plugin)" + + ``` bash + docker compose down + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose down + docker-compose up -d + ``` ### Log rotation diff --git a/docs/troubleshooting/debug-admin_login_sogo.de.md b/docs/troubleshooting/debug-admin_login_sogo.de.md index e3ec735e7..c5eaa935e 100644 --- a/docs/troubleshooting/debug-admin_login_sogo.de.md +++ b/docs/troubleshooting/debug-admin_login_sogo.de.md @@ -10,9 +10,18 @@ Die Funktion ist standardmäßig deaktiviert. Es kann in der `mailcow.conf` durc ALLOW_ADMIN_EMAIL_LOGIN=y ``` und die betroffenen Container neu erstellen mit -``` -docker compose up -d -``` + +=== "docker compose (Plugin)" + + ``` bash + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose up -d + ``` ## Nachteile bei Aktivierung diff --git a/docs/troubleshooting/debug-admin_login_sogo.en.md b/docs/troubleshooting/debug-admin_login_sogo.en.md index aff5edfda..23e4286b4 100644 --- a/docs/troubleshooting/debug-admin_login_sogo.en.md +++ b/docs/troubleshooting/debug-admin_login_sogo.en.md @@ -12,9 +12,18 @@ The feature is disabled by default. It can be enabled in the `mailcow.conf` by s ALLOW_ADMIN_EMAIL_LOGIN=y ``` and recreating the affected containers with -``` -docker compose up -d -``` + +=== "docker compose (Plugin)" + + ``` bash + docker compose up -d + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose up -d + ``` ## Drawbacks when enabled diff --git a/docs/troubleshooting/debug-attach_service.de.md b/docs/troubleshooting/debug-attach_service.de.md index 2badb19df..635427e96 100644 --- a/docs/troubleshooting/debug-attach_service.de.md +++ b/docs/troubleshooting/debug-attach_service.de.md @@ -2,9 +2,17 @@ Um einen Container an Ihre Shell anzuhängen, können Sie einfach folgendes ausführen -``` -docker compose exec $Dienst_Name /bin/bash -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec $Dienst_Name /bin/bash + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec $Dienst_Name /bin/bash + ``` ### Verbindung zu Diensten herstellen @@ -12,16 +20,34 @@ Wenn Sie sich direkt mit einem Dienst / einer Anwendung verbinden wollen, ist es #### MySQL -``` -Quelle mailcow.conf -docker compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} -``` + +=== "docker compose (Plugin)" + + ``` bash + source mailcow.conf + docker compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} + ``` + +=== "docker-compose (Standalone)" + + ``` bash + source mailcow.conf + docker-compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} + ``` #### Redis -``` -docker compose exec redis-mailcow redis-cli -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec redis-mailcow redis-cli + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec redis-mailcow redis-cli + ``` ## Dienstbeschreibungen diff --git a/docs/troubleshooting/debug-attach_service.en.md b/docs/troubleshooting/debug-attach_service.en.md index 65680c47d..f0f1e0bfa 100644 --- a/docs/troubleshooting/debug-attach_service.en.md +++ b/docs/troubleshooting/debug-attach_service.en.md @@ -2,9 +2,17 @@ To attach a container to your shell you can simply run -``` -docker compose exec $Service_Name /bin/bash -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec $Dienst_Name /bin/bash + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec $Dienst_Name /bin/bash + ``` ### Connecting to Services @@ -12,16 +20,33 @@ If you want to connect to a service / application directly it is always a good i #### MySQL -``` -source mailcow.conf -docker compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} -``` +=== "docker compose (Plugin)" + + ``` bash + source mailcow.conf + docker compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} + ``` + +=== "docker-compose (Standalone)" + + ``` bash + source mailcow.conf + docker-compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} + ``` #### Redis -``` -docker compose exec redis-mailcow redis-cli -``` +=== "docker compose (Plugin)" + + ``` bash + docker compose exec redis-mailcow redis-cli + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose exec redis-mailcow redis-cli + ``` ## Service Descriptions diff --git a/docs/troubleshooting/debug-logs.de.md b/docs/troubleshooting/debug-logs.de.md index f77831b9c..dea6f0186 100644 --- a/docs/troubleshooting/debug-logs.de.md +++ b/docs/troubleshooting/debug-logs.de.md @@ -1,9 +1,35 @@ !!! warning Dieser Abschnitt gilt nur für Docker's Standard-Logging-Treiber (JSON). -Um die Logs aller mailcow: dockerized bezogenen Container zu sehen, können Sie `docker compose logs` innerhalb Ihres mailcow-dockerized Ordners verwenden, der Ihre `mailcow.conf` enthält. Dies ist normalerweise ein bisschen viel, aber Sie können die Ausgabe mit `--tail=100` auf die letzten 100 Zeilen pro Container kürzen, oder ein `-f` hinzufügen, um die Live-Ausgabe aller Ihrer Dienste zu verfolgen. +Um die Logs aller mailcow: dockerized bezogenen Container zu sehen, können Sie den folgenden Befehl innerhalb Ihres mailcow-dockerized Ordners verwenden, der Ihre `mailcow.conf` enthält: -Um die Logs eines bestimmten Dienstes zu sehen, kann man `docker compose logs [options] $service_name` verwenden +=== "docker compose (Plugin)" + + ``` bash + docker compose logs + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose logs + ``` + +Dies ist normalerweise ein bisschen viel, aber Sie können die Ausgabe mit `--tail=100` auf die letzten 100 Zeilen pro Container kürzen, oder ein `-f` hinzufügen, um die Live-Ausgabe aller Ihrer Dienste zu verfolgen. + +Um die Logs eines bestimmten Dienstes zu sehen, kann man folgendes verwenden: + +=== "docker compose (Plugin)" + + ``` bash + docker compose logs [options] $service_name + ``` + +=== "docker-compose (Standalone)" + + ``` bash + docker-compose logs [options] $service_name + ``` !!! info Die verfügbaren Optionen für den Befehl **docker compose logs** sind: diff --git a/overrides/main.html b/overrides/main.html index 042e56f7a..0ca4fb7e1 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -1,6 +1,11 @@ {% extends "base.html" %} {% block announce %} -

Alle Befehle sind gemäß der Syntax des Docker Compose Plugin und der Standalone Variante anschaubar.
- All Commands are available according to the Docker Compose Plugin and the Standalone Version

+{% if config.theme.language == 'de' %} +

Alle Befehle sind gemäß der Syntax des Docker Compose Plugin und der Standalone Variante anwählbar.

+{% elif config.theme.language == 'en' %} +

All Commands are available according to the Docker Compose Plugin and the Standalone Version

+{% else %} +

All Commands are available according to the Docker Compose Plugin and the Standalone Version

+{% endif %} {% endblock %} \ No newline at end of file