docs: Fix path in dkim helper script (rspamd) #4531
Conversation
| You should have: | ||
|
|
||
| - At least one [email account setup][docs-accounts] | ||
| - Attached a [volume for config][docs-volumes-config] to persist the generated files to local storage |
There was a problem hiding this comment.
This is not rspamd specific, it's making the user aware of the importance of the config volume being required for persistence / storage of the generated DKIM keys.
While that should be an obvious requirement, it may not be obvious where (which volume) the generated files would be otherwise stored?
I don't see any harm keeping it, since different users navigate the docs and gain better awareness of how to configure DMS differently 😅
I looked into where we introduced this line but it came from the original Github Wiki before migrating to generated docs (in the dkim.md file before our docs later merged the DKIM page with SPF + DMARC pages).
| In case you have not already provided a default DKIM signing configuration, the script will create one and write it to `/etc/rspamd/override.d/dkim_signing.conf`. If this file already exists, it will not be overwritten. | ||
|
|
||
| When you're already using [the `rspamd/override.d/` directory][docs-rspamd-config-dropin], the file is created inside your volume and therefore persisted correctly. If you are not using `rspamd/override.d/`, you will need to persist the file yourself (otherwise it is lost on container restart). | ||
| In case you have not already provided a default DKIM signing configuration, the script will create one and write it to `/tmp/docker-mailserver/rspamd/override.d/dkim_signing.conf` (which will be persisted with the default volume mounts). If this file already exists, it will not be overwritten. |
There was a problem hiding this comment.
If bringing back the config volume requirement, the persistence note here is not needed:
| In case you have not already provided a default DKIM signing configuration, the script will create one and write it to `/tmp/docker-mailserver/rspamd/override.d/dkim_signing.conf` (which will be persisted with the default volume mounts). If this file already exists, it will not be overwritten. | |
| In case you have not already provided a default DKIM signing configuration, the script will create one and write it to `/tmp/docker-mailserver/rspamd/override.d/dkim_signing.conf`. If this file already exists, it will not be overwritten. |
|
ping @fim-sh |
|
Sorry, was on vacation. Thanks for the review, pushed requested changes 😄 |
polarathene
left a comment
There was a problem hiding this comment.
LGTM 👍
Thanks for the contribution! ❤️
|
Documentation preview for this PR is ready! 🎉 Built with commit: 0fc63f2 |
Description
This PR improves the DKIM setup docs by correcting the config path that the helper script uses, and it removes the mentioned need for additional config volume mount.
Fixes #4521
Type of change
Checklist
docs/)CHANGELOG.md