feat(web): update to mailserver-admin 5.14.1 and add observability configuration

Author: jeboehm

.env.dist

@@ -17,7 +17,7 @@ MAILNAME=mail.example.com
 [email protected]
 
 # Relay mails to another SMTP server
-# @see docs/RELAYHOST.md
+# @see docs/configuration/relayhost.md
 RELAYHOST=false
 RELAY_PASSWD_FILE=false
 
@@ -27,11 +27,14 @@ FILTER_MIME=false
 # Password to access the rspamd web-interface
 CONTROLLER_PASSWORD=changeme2
 
+# Password to access the dovecot doveadm api
+DOVEADM_API_KEY=changeme2
+
 # How long to wait for services to start
 WAITSTART_TIMEOUT=2m
 
 # Configure local address extension
-# @see docs/LOCAL_ADDRESS_EXTENSION.md
+# @see docs/configuration/local-address-extension.md
 RECIPIENT_DELIMITER=-
 
 # Interval in seconds for fetchmail to check for new mails

deploy/kustomize/common/configmap.yaml

@@ -6,6 +6,7 @@ data:
   FILTER_MILTER_ADDRESS: filter:11332
   FILTER_WEB_ADDRESS: filter:11334
   MDA_AUTH_ADDRESS: mda:2004
+  MDA_DOVEADM_ADDRESS: mda:8080
   MDA_IMAP_ADDRESS: mda:143
   MDA_IMAPS_ADDRESS: mda:993
   MDA_LMTP_ADDRESS: mda:2003

deploy/kustomize/mda/network-policy.yaml

@@ -33,6 +33,8 @@ spec:
           port: 2004 # Auth
         - protocol: TCP
           port: 4190 # ManageSieve
+        - protocol: TCP
+          port: 8080 # Doveadm
     # Allow external access (from internet)
     - from:
         - ipBlock:

docs/configuration/environment-variables.md

@@ -40,11 +40,10 @@ It is required to **always set** `REDIS_PASSWORD`.
 
 ### Authentication
 
-This is the password for the RSpamd controller access. It is required to **always set** `CONTROLLER_PASSWORD`.
-
 | Variable              | Default      | Description                           |
 | --------------------- | ------------ | ------------------------------------- |
 | `CONTROLLER_PASSWORD` | _(required)_ | Password for RSpamd controller access |
+| `DOVEADM_API_KEY`     | _(required)_ | Password for Dovecot API access       |
 
 ### Relay Configuration
 

target/web/Dockerfile

@@ -10,15 +10,20 @@ ENV MYSQL_HOST=db \
     MYSQL_USER=mailserver \
     REDIS_HOST=redis \
     REDIS_PORT=6379 \
+    APP_SHARE_DIR="var/cache" \
+    DATABASE_URL="mysql://%env(MYSQL_USER)%:%env(MYSQL_PASSWORD)%@%env(MYSQL_HOST)%:%env(MYSQL_PORT)%/%env(MYSQL_DATABASE)%?serverVersion=8.4" \
+    DOVEADM_HTTP_URL="https://%env(MDA_DOVEADM_ADDRESS)%" \
     FILTER_WEB_ADDRESS=filter:11334 \
+    MAILNAME=mail.example.com \
+    MDA_DOVEADM_ADDRESS=mda:8080 \
     MDA_IMAP_ADDRESS=mda:31143 \
     MDA_MANAGESIEVE_ADDRESS=mda:4190 \
     MTA_SMTP_SUBMISSION_ADDRESS=mta:587 \
+    RSPAMD_CONTROLLER_URL="http://%env(FILTER_WEB_ADDRESS)%" \
+    RSPAMD_PASSWORD="%env(CONTROLLER_PASSWORD)%" \
+    SERVER_ROOT=/var/www/html \
     SUPPORT_URL=https://github.com/jeboehm/docker-mailserver \
-    MAILNAME=mail.example.com \
-    WAITSTART_TIMEOUT=1m \
-    DATABASE_URL="mysql://%env(MYSQL_USER)%:%env(MYSQL_PASSWORD)%@%env(MYSQL_HOST)%:%env(MYSQL_PORT)%/%env(MYSQL_DATABASE)%?serverVersion=8.4" \
-    SERVER_ROOT=/var/www/html
+    WAITSTART_TIMEOUT=1m
 
 ARG FRANKENPHP_VER=v1.11.1 # renovate: depName=php/frankenphp
 RUN apk add --no-cache \
@@ -74,17 +79,15 @@ RUN --mount=type=cache,target=/root/.composer \
 
 FROM composer AS admin-builder
 
-ARG ADMIN_VER=5.13.4 # renovate: depName=jeboehm/mailserver-admin
+ARG ADMIN_VER=5.14.1 # renovate: depName=jeboehm/mailserver-admin
 WORKDIR /opt/admin
 RUN curl -sSLf \
         -o /tmp/admin.tar.gz \
         https://github.com/jeboehm/mailserver-admin/releases/download/${ADMIN_VER}/release-${ADMIN_VER}.tar.gz && \
-    tar -oxf /tmp/admin.tar.gz --strip=1 && \
+    tar -oxf /tmp/admin.tar.gz && \
     rm /tmp/admin.tar.gz && \
-    composer symfony:dump-env prod && \
     chmod 777 \
         /opt/admin/var/cache \
-        /opt/admin/var/cache/prod \
         /opt/admin/var/log
 
 FROM base AS prod

test/bats/integration/070_docker.bats

@@ -16,3 +16,9 @@ setup() {
 
 	[ "$status" -eq 0 ]
 }
+
+@test "system:check command succeeds" {
+	run docker exec docker-mailserver-web-1 /opt/admin/bin/console system:check --all
+
+	[ "$status" -eq 0 ]
+}