From 3eba74d2cb78b537263dd5cfabac59db28d92955 Mon Sep 17 00:00:00 2001 From: polarathene <5098581+polarathene@users.noreply.github.com> Date: Sat, 27 Jan 2024 16:31:14 +1300 Subject: [PATCH] docs: Adjust link ref convention This is more search friendly / organized to find references to all DMS volumes. --- docs/content/config/environment.md | 4 ++-- docs/content/config/security/fail2ban.md | 4 ++-- docs/content/config/security/rspamd.md | 8 ++++---- docs/content/config/security/ssl.md | 4 ++-- docs/content/faq.md | 6 +++--- docs/content/usage.md | 4 ++-- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/content/config/environment.md b/docs/content/config/environment.md index 90e5bbf3..2713de96 100644 --- a/docs/content/config/environment.md +++ b/docs/content/config/environment.md @@ -646,7 +646,7 @@ Controls the spam score threshold for triggering an action on mail that has a hi If emails are quarantined, they are compressed and stored at a location: - Default: `/var/lib/amavis/virusmails/` - - When the [`/var/mail-state/` volume][docs-dms-state-volume] is present: `/var/mail-state/lib-amavis/virusmails/` + - When the [`/var/mail-state/` volume][docs::dms-volumes-state] is present: `/var/mail-state/lib-amavis/virusmails/` !!! tip @@ -1056,4 +1056,4 @@ you to replace both instead of just the envelope sender. [docs-tls-manual]: ./security/ssl.md#bring-your-own-certificates [docs-tls-selfsigned]: ./security/ssl.md#self-signed-certificates [docs-accounts-quota]: ./user-management.md#quotas -[docs-dms-state-volume]: ./config/advanced/optional-config.md#volumes-state \ No newline at end of file +[docs::dms-volumes-state]: ./advanced/optional-config.md#volumes-state \ No newline at end of file diff --git a/docs/content/config/security/fail2ban.md b/docs/content/config/security/fail2ban.md index 89a39e4e..375f440c 100644 --- a/docs/content/config/security/fail2ban.md +++ b/docs/content/config/security/fail2ban.md @@ -33,7 +33,7 @@ DMS will automatically ban IP addresses of hosts that have generated 6 failed at ### Custom Files -!!! question "What is [`docker-data/dms/config/`][docs-dms-config-volume]?" +!!! question "What is [`docker-data/dms/config/`][docs::dms-volumes-config]?" This following configuration files inside the `docker-data/dms/config/` volume will be copied inside the container during startup @@ -44,7 +44,7 @@ This following configuration files inside the `docker-data/dms/config/` volume w - with this file, you can adjust F2B behavior in general - there is an example provided [in our repository on GitHub][github-file-f2bconfig] -[docs-dms-config-volume]: ../advanced/optional-config.md#volumes-config +[docs::dms-volumes-config]: ../advanced/optional-config.md#volumes-config [github-file-f2bjail]: https://github.com/docker-mailserver/docker-mailserver/blob/master/config-examples/fail2ban-jail.cf [github-file-f2bconfig]: https://github.com/docker-mailserver/docker-mailserver/blob/master/config-examples/fail2ban-fail2ban.cf diff --git a/docs/content/config/security/rspamd.md b/docs/content/config/security/rspamd.md index eda0ecc8..c0ca011b 100644 --- a/docs/content/config/security/rspamd.md +++ b/docs/content/config/security/rspamd.md @@ -85,7 +85,7 @@ DMS does not set a default password for the controller worker. You may want to d When Rspamd is enabled, we implicitly also start an instance of Redis in the container: -- Redis is configured to persist its data via RDB snapshots to disk in the directory `/var/lib/redis` (_or the [`/var/mail-state/`][docs-dms-state-volume] volume when present_). +- Redis is configured to persist its data via RDB snapshots to disk in the directory `/var/lib/redis` (_or the [`/var/mail-state/`][docs::dms-volumes-state] volume when present_). - With the volume mount the snapshot will restore the Redis data across container restarts, and provide a way to keep backup. Redis uses `/etc/redis/redis.conf` for configuration: @@ -151,7 +151,7 @@ DMS brings sane default settings for Rspamd. They are located at `/etc/rspamd/lo ### Manually -!!! question "What is [`docker-data/dms/config/`][docs-dms-config-volume]?" +!!! question "What is [`docker-data/dms/config/`][docs::dms-volumes-config]?" If you want to overwrite the default settings and / or provide your own settings, you can place files at `docker-data/dms/config/rspamd/override.d/`. Files from this directory are copied to `/etc/rspamd/override.d/` during startup. These files [forcibly override][rspamd-docs-override-dir] Rspamd and DMS default settings. @@ -258,5 +258,5 @@ While _Abusix_ can be integrated into Postfix, Postscreen and a multitude of oth [Abusix]: https://abusix.com/ [abusix-rspamd-integration]: https://docs.abusix.com/abusix-mail-intelligence/gbG8EcJ3x3fSUv8cMZLiwA/getting-started/dmw9dcwSGSNQiLTssFAnBW#rspamd -[docs-dms-config-volume]: ../advanced/optional-config.md#volumes-config -[docs-dms-state-volume]: ../advanced/optional-config.md#volumes-state \ No newline at end of file +[docs::dms-volumes-config]: ../advanced/optional-config.md#volumes-config +[docs::dms-volumes-state]: ../advanced/optional-config.md#volumes-state \ No newline at end of file diff --git a/docs/content/config/security/ssl.md b/docs/content/config/security/ssl.md index 264d5e72..10f7adc4 100644 --- a/docs/content/config/security/ssl.md +++ b/docs/content/config/security/ssl.md @@ -634,7 +634,7 @@ This setup only comes with one caveat: The domain has to be configured on anothe Use self-signed certificates only for testing purposes! -This feature requires you to provide the following files into your [`docker-data/dms/config/ssl/` directory][docs-dms-config-volume] (_internal location: `/tmp/docker-mailserver/ssl/`_): +This feature requires you to provide the following files into your [`docker-data/dms/config/ssl/` directory][docs::dms-volumes-config] (_internal location: `/tmp/docker-mailserver/ssl/`_): - `-key.pem` - `-cert.pem` @@ -876,7 +876,7 @@ By default DMS uses [`ffdhe4096`][ffdhe4096-src] from [IETF RFC 7919][ietf::rfc: Despite this, if you must use non-standard DH parameters or you would like to swap `ffdhe4096` for a different group (eg `ffdhe2048`); Add your own PEM encoded DH params file via a volume to `/tmp/docker-mailserver/dhparams.pem`. This will replace DH params for both Dovecot and Postfix services during container startup. [docs-env::ssl-type]: ../environment.md#ssl_type -[docs-dms-config-volume]: ../advanced/optional-config.md#volumes-config +[docs::dms-volumes-config]: ../advanced/optional-config.md#volumes-config [docs-faq-baredomain]: ../../faq.md#can-i-use-a-nakedbare-domain-ie-no-hostname [github-file-compose]: https://github.com/docker-mailserver/docker-mailserver/blob/master/compose.yaml diff --git a/docs/content/faq.md b/docs/content/faq.md index 16ccad29..6b1782e3 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -378,7 +378,7 @@ Put received spams in `.Junk/` imap folder using `SPAMASSASSIN_SPAM_TO_INBOX=1` !!! example - **NOTE:** This example assumes you have a [`/var/mail-state` volume][docs-dms-state-volume] mounted. + **NOTE:** This example assumes you have a [`/var/mail-state` volume][docs::dms-volumes-state] mounted. ```conf # m h dom mon dow command @@ -392,7 +392,7 @@ The following configuration works nicely: ??? example - **NOTE:** This example assumes you have a [`/var/mail-state` volume][docs-dms-state-volume] mounted. + **NOTE:** This example assumes you have a [`/var/mail-state` volume][docs::dms-volumes-state] mounted. Create a _system_ cron file: @@ -481,7 +481,7 @@ $spam_quarantine_to = "quarantine\@example.com"; ``` [fail2ban-customize]: ./config/security/fail2ban.md -[docs-dms-state-volume]: ./config/advanced/optional-config.md#volumes-state +[docs::dms-volumes-state]: ./config/advanced/optional-config.md#volumes-state [docs-maintenance]: ./config/advanced/maintenance/update-and-cleanup.md [docs-override-postfix]: ./config/advanced/override-defaults/postfix.md [docs-userpatches]: ./config/advanced/override-defaults/user-patches.md diff --git a/docs/content/usage.md b/docs/content/usage.md index 84438a55..30f6e822 100644 --- a/docs/content/usage.md +++ b/docs/content/usage.md @@ -2,9 +2,9 @@ title: Usage --- -This pages explains how to get started with DMS. The guide uses Docker Compose as a reference. In our examples, a volume mounts the host location [`docker-data/dms/config/`][docs-dms-config-volume] to `/tmp/docker-mailserver/` inside the container. +This pages explains how to get started with DMS. The guide uses Docker Compose as a reference. In our examples, a volume mounts the host location [`docker-data/dms/config/`][docs::dms-volumes-config] to `/tmp/docker-mailserver/` inside the container. -[docs-dms-config-volume]: ./config/advanced/optional-config.md#volumes-config +[docs::dms-volumes-config]: ./config/advanced/optional-config.md#volumes-config ## Preliminary Steps