Skip to content

Commit bbc54c7

Browse files
docs: update FAQ entries (docker-mailserver#3294)
* removed FAQ entry about Rancher, see <docker-mailserver#3289 (comment)> * update FAQ about special directories, see <docker-mailserver#3289 (comment)>
1 parent f9d55a9 commit bbc54c7

2 files changed

Lines changed: 17 additions & 22 deletions

File tree

docs/content/config/advanced/optional-config.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ hide:
44
- toc # Hide Table of Contents for this page
55
---
66

7-
This is a list of all configuration files and directories which are optional or automatically generated in your `docker-data/dms/config/` directory. We use this path to reference the local config directory in our docs, which you should attach a volume into the container at `/tmp/docker-mailserver`.
7+
This is a list of all configuration files and directories which are optional or automatically generated in your [`docker-data/dms/config/`][docs-dms-config-volume] directory.
88

99
## Directories
1010

@@ -42,6 +42,7 @@ This is a list of all configuration files and directories which are optional or
4242
- **user-patches.sh:** this file will be run after all configuration files are set up, but before the postfix, amavis and other daemons are started. (Docs: [FAQ - How to adjust settings with the `user-patches.sh` script][docs-faq-userpatches])
4343
- **rspamd/custom-commands.conf:** list of simple commands to adjust Rspamd modules in an easy way (Docs: [Rspamd][docs-rspamd-commands])
4444

45+
[docs-dms-config-volume]: ../../faq.md#what-about-the-docker-datadmsconfig-directory
4546
[docs-accounts-quota]: ../../config/user-management.md#quotas
4647
[docs-aliases-regex]: ../../config/user-management.md#configuring-regexp-aliases
4748
[docs-dkim]: ../../config/best-practices/dkim_dmarc_spf.md#dkim

docs/content/faq.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ None! No database is required. The filesystem is the database. This image is bas
1010

1111
Mails are stored in `/var/mail/${domain}/${username}`. Since `v9.0.0` it is possible to add custom `user_attributes` for each accounts to have a different mailbox configuration (See [#1792][github-issue-1792]).
1212

13-
### What About the `docker-data/dms/config/` Directory?
14-
15-
This documentation and all example configuration files in the GitHub repository use `docker-data/dms/config/` to refer to the directory in the host that is mounted (e.g. via a bind mount) to `/tmp/docker-mailserver/` inside the container,.
16-
1713
### How are IMAP mailboxes (_aka IMAP Folders_) set up?
1814

1915
`INBOX` is setup by default with the special IMAP folders `Drafts`, `Sent`, `Junk` and `Trash`. You can learn how to modify or add your own folders (_including additional special folders like `Archive`_) by visiting our docs page [_Customizing IMAP Folders_](../examples/use-cases/imap-folders) for more information.
@@ -130,15 +126,6 @@ docker run --rm -it \
130126
find "${PWD}/docker-data/dms-backups/" -type f -mtime +30 -delete
131127
```
132128

133-
### What about the `./docker-data/dms/mail-state` folder?
134-
135-
When you run DMS with the ENV variable `ONE_DIR=1` (default), this folder will:
136-
137-
- Provide support to persist Fail2Ban blocks, ClamAV signature updates, and the like when the container is restarted or recreated.
138-
- To persist that container state properly this folder should be **volume mounted to `/var/mail-state/` internally**.
139-
140-
Service data is [relocated to the `mail-state` folder][mail-state-folders] for the following services: Postfix, Dovecot, Fail2Ban, Amavis, PostGrey, ClamAV, SpamAssassin.
141-
142129
### I Want to Know More About the Ports
143130

144131
See [this part of the documentation](../config/security/understanding-the-ports/) for further details and best practice advice, **especially regarding security concerns**.
@@ -237,14 +224,6 @@ If everything is OK regarding DNS, please provide [formatted logs](https://guide
237224

238225
If we're blind, we won't be able to do anything.
239226

240-
### Can DMS run in a Rancher environment?
241-
242-
Yes, by adding the environment variable `PERMIT_DOCKER: network`.
243-
244-
!!! warning
245-
246-
Adding the Docker network's gateway to the list of trusted hosts, e.g. using the `network` or `connected-networks` option, can create an [**open relay**](https://en.wikipedia.org/wiki/Open_mail_relay), for instance [if IPv6 is enabled on the host machine but not in Docker][github-issue-1405-comment].
247-
248227
### Connection refused or No response at all
249228

250229
You see errors like "Connection Refused" and "Connection closed by foreign host", or you cannot connect at all? You may not be able to connect with your mail client (MUA)? Make sure to check Fail2Ban did not ban you (for exceeding the number of tried logins for example)! You can run
@@ -373,6 +352,20 @@ DMS does not manage those concerns, verify they are not causing your delivery pr
373352
- [mail-tester](https://www.mail-tester.com/) can test your deliverability.
374353
- [helloinbox](https://www.helloinbox.email/) provides a checklist of things to improve your deliverability.
375354

355+
### Special Directories
356+
357+
#### What About the `docker-data/dms/config/` Directory?
358+
359+
This documentation and all example configuration files in the GitHub repository use `docker-data/dms/config/` to refer to the directory in the host that is mounted (e.g. via a bind mount) to `/tmp/docker-mailserver/` inside the container.
360+
361+
Most configuration files for Postfix, Dovecot, etc. are persisted here. [Optional configuration][docs-optional-configuration] is stored here as well.
362+
363+
#### What About the `docker-data/dms/mail-state/` Directory?
364+
365+
This documentation and all example configuration files in the GitHub repository use `docker-data/dms/mail-state/` to refer to the directory in the host that is mounted (e.g. via a bind mount) to `/var/mail-state/` inside the container.
366+
367+
When you run DMS with the ENV variable `ONE_DIR=1` (default), this directory will provide support to persist Fail2Ban blocks, ClamAV signature updates, and the like when the container is restarted or recreated. Service data is [relocated to the `mail-state` folder][mail-state-folders] for the following services: Postfix, Dovecot, Fail2Ban, Amavis, PostGrey, ClamAV, SpamAssassin, Rspamd & Redis.
368+
376369
### SpamAssasin
377370

378371
#### How can I manage my custom SpamAssassin rules?
@@ -539,3 +532,4 @@ $spam_quarantine_to = "amavis\@example.com";
539532
[github-issue-1792]: https://github.com/docker-mailserver/docker-mailserver/pull/1792
540533
[hanscees-userpatches]: https://github.com/hanscees/dockerscripts/blob/master/scripts/tomav-user-patches.sh
541534
[mail-state-folders]: https://github.com/docker-mailserver/docker-mailserver/blob/c7e498194546416fb7231cb03254e77e085d18df/target/scripts/startup/misc-stack.sh#L24-L33
535+
[docs-optional-configuration]: ./config/advanced/optional-config.md

0 commit comments

Comments
 (0)