mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
3ef59c3def
Add Docker-based deployment: Dockerfile based on systemd image, docker-compose.yaml, build script, entrypoint, external certificate monitoring, CI workflow, and documentation. This builds on the chatmaild/cmdeploy preparation in the previous commit (j4n/docker-prep-chatmail) which added the env-var-driven feature flags (CHATMAIL_NOSYSCTL, CHATMAIL_NOPORTCHECK, CHATMAIL_NOACME) and @local deployment support needed by the container. This is commit 2 of 3 to merge squashed changes on j4n/docker and docker branches, original commits were beef0ec..606f36e Architecture overview (mostly by original author Keonik1): - Debian-systemd image wrapping the existing cmdeploy install - Host networking to not manually expose the many ports needed - Config via MAIL_DOMAIN env var or (new) mounted chatmail.ini - New: cmdeploy stages: install at build, configure+activate at startup - New: Monitoring service for external certs via systemd timer (chatmail-certmon) - New: Image version tracking for automatic upgrade detection (cm + config hash) - New: docker-compose.override.yaml pattern for user customizations - New: GitHub Actions CI for ghcr.io image builds Traefik reverse-proxy support is prepared but the specific files are excluded from this PR and will be submitted separately. TODO: - [ ] Pull out CHATMAIL_NOACME as PR #855 introduced a proper mechanism - [ ] Check if underlying image could be based on regular debian-slim images with a step to enable systemd, similar to https://github.com/alexdzyoba/docker-debian-systemd Files added: .dockerignore .github/workflows/docker-build.yaml docker-compose.yaml docker-compose.override.yaml.example docker/build.sh docker/chatmail_relay.dockerfile docker/files/chatmail-certmon.{service,sh,timer} docker/files/entrypoint.sh docker/files/setup_chatmail.service docker/files/setup_chatmail_docker.sh env.example doc/source/docker.rst Files modified: .gitignore doc/source/getting_started.rst doc/source/index.rst Co-authored-by: Keonik1 <keonik.dev@gmail.com> Co-authored-by: missytake <missytake@systemli.org>
34 lines
1.4 KiB
Plaintext
34 lines
1.4 KiB
Plaintext
# Local overrides — copy to docker-compose.override.yaml in the repo root.
|
|
# Compose automatically merges this with docker-compose.yaml.
|
|
#
|
|
# cp docker/docker-compose.override.yaml.example docker-compose.override.yaml
|
|
#
|
|
# Volumes listed here are APPENDED to the base file's volumes.
|
|
# Scalar values (environment, image, etc.) are REPLACED.
|
|
services:
|
|
chatmail:
|
|
volumes:
|
|
## Data paths — bind-mount to host directories for easy access/backup.
|
|
## Uncomment and adjust paths as needed. These override the named
|
|
## volumes in the base docker-compose.yaml.
|
|
# - ./data/chatmail:/home/vmail
|
|
# - ./data/chatmail-dkimkeys:/etc/dkimkeys
|
|
# - ./data/chatmail-acme:/var/lib/acme
|
|
|
|
## Or mount data from an existing bare-metal install.
|
|
## Note: DKIM key ownership is fixed automatically on startup
|
|
## (the host's opendkim UID may differ from the container's).
|
|
# - /home/vmail:/home/vmail
|
|
# - /etc/dkimkeys:/etc/dkimkeys
|
|
# - /var/lib/acme:/var/lib/acme
|
|
|
|
## Mount your own chatmail.ini (skips auto-generation):
|
|
# - ./chatmail.ini:/etc/chatmail/chatmail.ini
|
|
|
|
## Custom website:
|
|
# - ./custom/www:/opt/chatmail-www
|
|
|
|
## Debug — mount scripts from the repo for live editing:
|
|
# - ./docker/files/setup_chatmail_docker.sh:/setup_chatmail_docker.sh
|
|
# - ./docker/files/entrypoint.sh:/entrypoint.sh
|