FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: Fix path in dkim helper script (rspamd) by fim-sh · Pull Request #4531 · docker-mailserver/docker-mailserver · GitHub

/ docker-mailserver Public

docs: Fix path in dkim helper script (rspamd) - #4531

Merged
polarathene merged 8 commits into
docker-mailserver:masterfrom
fim-sh:master
Aug 1, 2025
ConversationCommits (8)ChecksFiles changed
Merged

docs: Fix path in dkim helper script (rspamd)#4531
polarathene merged 8 commits into
docker-mailserver:masterfrom
fim-sh:master

Conversation

fim-sh commented Jul 23, 2025

Copy link
Copy Markdown
Contributor

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

  • Bug fix (non-breaking change which fixes an issue)
  • Improvement (non-breaking change that does improve existing functionality)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary, I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added information about changes made in this PR to CHANGELOG.md

polarathene requested changes Jul 24, 2025
View reviewed changes
Comment thread docs/content/config/best-practices/dkim_dmarc_spf.md
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

polarathene Jul 23, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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).

Comment thread docs/content/config/best-practices/dkim_dmarc_spf.md
Comment thread docs/content/config/best-practices/dkim_dmarc_spf.md Outdated
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.

polarathene Jul 24, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

If bringing back the config volume requirement, the persistence note here is not needed:

Suggested change
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.

polarathene added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Jul 24, 2025
polarathene added this to the v15.1.0 milestone Jul 24, 2025

georglauterbach commented Jul 30, 2025

Copy link
Copy Markdown
Member

ping @fim-sh

fim-sh commented Jul 31, 2025

Copy link
Copy Markdown
Contributor Author

Sorry, was on vacation. Thanks for the review, pushed requested changes 😄

polarathene reviewed Aug 1, 2025
View reviewed changes
Comment thread CHANGELOG.md Outdated
polarathene approved these changes Aug 1, 2025
View reviewed changes

polarathene left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM 👍

Thanks for the contribution! ❤️

github-actions Bot commented Aug 1, 2025

Copy link
Copy Markdown
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: 0fc63f2

polarathene merged commit 7a0b499 into docker-mailserver:master Aug 1, 2025
3 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

polarathene polarathene approved these changes

Assignees

fim-sh

Labels

area/documentation kind/improvement Improve an existing feature, configuration file or the documentation

Projects

None yet

Milestone

v15.1.0

Development

Successfully merging this pull request may close these issues.

docs: Update saving location for default DKIM signing configuration

3 participants

Back | FazBrowse Home | New Git URL