chore: Review feedback

This commit is contained in:
Brennan Kinney 2025-02-17 18:38:16 +13:00 committed by GitHub
parent 22786b7def
commit 7a18a20587
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 19 additions and 17 deletions

View File

@ -19,7 +19,7 @@ All notable changes to this project will be documented in this file. The format
- This has been corrected to `/var/lib/getmail` (_if you have mounted a DMS State Volume to `/var/mail-state`, `/var/lib/getmail` will be symlinked to `/var/mail-state/lib-getmail`_). - This has been corrected to `/var/lib/getmail` (_if you have mounted a DMS State Volume to `/var/mail-state`, `/var/lib/getmail` will be symlinked to `/var/mail-state/lib-getmail`_).
- To preserve this state when upgrading to DMS v15, **you must manually migrate `getmail/` from the _DMS Config Volume_ to `lib-getmail/` in the _DMS State Volume_.** - To preserve this state when upgrading to DMS v15, **you must manually migrate `getmail/` from the _DMS Config Volume_ to `lib-getmail/` in the _DMS State Volume_.**
- `setup email delete <EMAIL ADDRESS>` now requires explicit confirmation if the mailbox data should be deleted ([#4365](https://github.com/docker-mailserver/docker-mailserver/pull/4365)). - `setup email delete <EMAIL ADDRESS>` now requires explicit confirmation if the mailbox data should be deleted ([#4365](https://github.com/docker-mailserver/docker-mailserver/pull/4365)).
- old **Rspamd** configuration file location (`/tmp/docker-mailserver/rspamd-modules.conf`) check was removed, use `/tmp/docker-mailserver/rspamd/custom-commands.conf` now - **Rspamd:** Removed deprecated file path check (_DMS config volume: `./rspamd-modules.conf` => `./rspamd/custom-commands.conf`_) ([#4373](https://github.com/docker-mailserver/docker-mailserver/pull/4373))
### Added ### Added
@ -29,7 +29,7 @@ All notable changes to this project will be documented in this file. The format
### Updates ### Updates
**Internal:** - **Internal:**
- **Removed `VERSION` file** from the repo. Releases of DMS prior to v13 (Nov 2023) would check this to detect new releases ([#3677](https://github.com/docker-mailserver/docker-mailserver/issues/3677), [#4321](https://github.com/docker-mailserver/docker-mailserver/pull/4321)) - **Removed `VERSION` file** from the repo. Releases of DMS prior to v13 (Nov 2023) would check this to detect new releases ([#3677](https://github.com/docker-mailserver/docker-mailserver/issues/3677), [#4321](https://github.com/docker-mailserver/docker-mailserver/pull/4321))
- During image build, ensure a secure connection when downloading the `fail2ban` package ([#4080](https://github.com/docker-mailserver/docker-mailserver/pull/4080)) - During image build, ensure a secure connection when downloading the `fail2ban` package ([#4080](https://github.com/docker-mailserver/docker-mailserver/pull/4080))
- **Documentation:** - **Documentation:**

View File

@ -1,10 +1,10 @@
# Docs: https://docker-mailserver.github.io/docker-mailserver/latest/config/advanced/mail-fetchmail # Docs: https://docker-mailserver.github.io/docker-mailserver/v15.0/config/advanced/mail-fetchmail
# Additional context, with CLI commands for verification: # Additional context, with CLI commands for verification:
# https://github.com/orgs/docker-mailserver/discussions/3994#discussioncomment-9290570 # https://github.com/orgs/docker-mailserver/discussions/3994#discussioncomment-9290570
services: services:
dms-fetch: dms-fetch:
image: ghcr.io/docker-mailserver/docker-mailserver:latest image: ghcr.io/docker-mailserver/docker-mailserver:latest # :15.0
hostname: mail.example.test hostname: mail.example.test
environment: environment:
ENABLE_FETCHMAIL: 1 ENABLE_FETCHMAIL: 1
@ -26,7 +26,7 @@ services:
target: /tmp/docker-mailserver/fetchmail.cf target: /tmp/docker-mailserver/fetchmail.cf
dms-remote: dms-remote:
image: ghcr.io/docker-mailserver/docker-mailserver:latest image: ghcr.io/docker-mailserver/docker-mailserver:latest # :15.0
hostname: mail.remote.test hostname: mail.remote.test
environment: environment:
# Allows for us send a test mail easily by trusting any mail client run within this container (`swaks`): # Allows for us send a test mail easily by trusting any mail client run within this container (`swaks`):

View File

@ -1,11 +1,11 @@
# Docs: https://docker-mailserver.github.io/docker-mailserver/latest/config/advanced/mail-forwarding/relay-hosts/ # Docs: https://docker-mailserver.github.io/docker-mailserver/v15.0/config/advanced/mail-forwarding/relay-hosts/
# Additional context, with CLI commands for verification: # Additional context, with CLI commands for verification:
# https://github.com/docker-mailserver/docker-mailserver/issues/4136#issuecomment-2253693490 # https://github.com/docker-mailserver/docker-mailserver/issues/4136#issuecomment-2253693490
services: services:
# This would represent your actual DMS container: # This would represent your actual DMS container:
dms-sender: dms-sender:
image: mailserver/docker-mailserver:latest image: mailserver/docker-mailserver:latest # :15.0
hostname: mail.example.test hostname: mail.example.test
environment: environment:
# All outbound mail will be relayed through this host # All outbound mail will be relayed through this host
@ -37,7 +37,7 @@ services:
# Pretend this is your third-party relay service: # Pretend this is your third-party relay service:
dms-relay: dms-relay:
image: mailserver/docker-mailserver:latest image: mailserver/docker-mailserver:latest # :15.0
hostname: smtp.relay-service.test hostname: smtp.relay-service.test
environment: environment:
# WORKAROUND: Bypass security checks from the mail-client (dms-sender container) # WORKAROUND: Bypass security checks from the mail-client (dms-sender container)
@ -58,7 +58,7 @@ services:
# Pretend this is another mail server that your target recipient belongs to (like Gmail): # Pretend this is another mail server that your target recipient belongs to (like Gmail):
dms-destination: dms-destination:
image: mailserver/docker-mailserver:latest image: mailserver/docker-mailserver:latest # :15.0
hostname: mail.destination.test hostname: mail.destination.test
# WORKAROUND: dms-relay must be able to resolve DNS for `@destination.test` to the IP of this container: # WORKAROUND: dms-relay must be able to resolve DNS for `@destination.test` to the IP of this container:
# Normally a MX record would direct mail to the MTA (eg: `mail.destination.test`) # Normally a MX record would direct mail to the MTA (eg: `mail.destination.test`)

View File

@ -151,6 +151,6 @@ We provide this support via two config files:
[wikipedia::smarthost]: https://en.wikipedia.org/wiki/Smart_host [wikipedia::smarthost]: https://en.wikipedia.org/wiki/Smart_host
[docs::env-relay]: ../../environment.md#relay-host [docs::env-relay]: ../../environment.md#relay-host
[dms-repo::helpers-relay]: https://github.com/docker-mailserver/docker-mailserver/blob/master/target/scripts/helpers/relay.sh [dms-repo::helpers-relay]: https://github.com/docker-mailserver/docker-mailserver/blob/v15.0.0/target/scripts/helpers/relay.sh
[dms-gh::pr-3607]: https://github.com/docker-mailserver/docker-mailserver/issues/3607 [dms-gh::pr-3607]: https://github.com/docker-mailserver/docker-mailserver/issues/3607
[dms-gh::relay-example]: https://github.com/docker-mailserver/docker-mailserver/issues/3842#issuecomment-1913380639 [dms-gh::relay-example]: https://github.com/docker-mailserver/docker-mailserver/issues/3842#issuecomment-1913380639

View File

@ -294,8 +294,8 @@ While _Abusix_ can be integrated into Postfix, Postscreen and a multitude of oth
[abusix-docs::rspamd-integration]: https://abusix.com/docs/rspamd/ [abusix-docs::rspamd-integration]: https://abusix.com/docs/rspamd/
[spamhaus::faq::dnsbl-usage]: https://www.spamhaus.org/faq/section/DNSBL%20Usage#365 [spamhaus::faq::dnsbl-usage]: https://www.spamhaus.org/faq/section/DNSBL%20Usage#365
[dms-repo::rspamd-actions-config]: https://github.com/docker-mailserver/docker-mailserver/blob/master/target/rspamd/local.d/actions.conf [dms-repo::rspamd-actions-config]: https://github.com/docker-mailserver/docker-mailserver/blob/v15.0.0/target/rspamd/local.d/actions.conf
[dms-repo::default-rspamd-configuration]: https://github.com/docker-mailserver/docker-mailserver/tree/master/target/rspamd [dms-repo::default-rspamd-configuration]: https://github.com/docker-mailserver/docker-mailserver/tree/v15.0.0/target/rspamd
[docs::env::enable-redis]: ../environment.md#enable_rspamd_redis [docs::env::enable-redis]: ../environment.md#enable_rspamd_redis
[docs::spam-to-junk]: ../environment.md#move_spam_to_junk [docs::spam-to-junk]: ../environment.md#move_spam_to_junk

View File

@ -44,19 +44,21 @@ As the official DMS image does not provide `dovecot-solr`, you'll need to includ
mailserver: mailserver:
hostname: mail.example.com hostname: mail.example.com
# The `image` setting now represents the tag for the local build configured below: # The `image` setting now represents the tag for the local build configured below:
image: local/dms:latest image: local/dms:${DMS_TAG?Must set DMS image tag}
# Local build (no need to try pull `image` remotely): # Local build (no need to try pull `image` remotely):
pull_policy: build pull_policy: build
# Add this `build` section to your real `compose.yaml` for your DMS service: # Add this `build` section to your real `compose.yaml` for your DMS service:
build: build:
dockerfile_inline: | dockerfile_inline: |
FROM docker.io/mailserver/docker-mailserver:latest FROM docker.io/mailserver/docker-mailserver:${DMS_TAG?Must set DMS image tag}
RUN apt-get update && apt-get install dovecot-solr RUN apt-get update && apt-get install dovecot-solr
``` ```
- Just run `docker compose up` and it will pull DMS and build your custom image to run a container. This approach only needs to install the package once with the image build itself which minimizes the delay of container startup.
- Updating to a new DMS release is straight-forward, just adjust the version tag as you normally would. If you make future changes that don't apply, you may need to force a rebuild.
- This approach only needs to install the package once with the image build itself. This minimizes delay of container startup. - Just run `DMS_TAG='14.0' docker compose up` and it will pull the DMS image, then build your custom DMS image to run a new container instance.
- Updating to a new DMS release is straight-forward, just adjust the `DMS_TAG` ENV value or change the image tag directly in `compose.yaml` as you normally would to upgrade an image.
- If you make future changes to the `dockerfile_inline` that don't seem to be applied, you may need to force a rebuild with `DMS_TAG='14.0' docker compose up --build`.
!!! note "Why doesn't DMS include `dovecot-solr`?" !!! note "Why doesn't DMS include `dovecot-solr`?"