docs: Revise docs for the OVERRIDE_HOSTNAME ENV#4492
Merged
polarathene merged 10 commits intodocker-mailserver:masterfrom Jun 2, 2025
Merged
docs: Revise docs for the OVERRIDE_HOSTNAME ENV#4492polarathene merged 10 commits intodocker-mailserver:masterfrom
OVERRIDE_HOSTNAME ENV#4492polarathene merged 10 commits intodocker-mailserver:masterfrom
Conversation
Changed the description of OVERRIDE_HOSTNAME environment variable, to raise awareness of unforeseen side effects.
Updated CHANGELOG to reflect changes in `mailserver.env`
removed trailing whitepace
polarathene
requested changes
May 27, 2025
OVERRIDE_HOSTNAMEOVERRIDE_HOSTNAME ENV
Added reference to PR like other entries
Align comment in mailserver.env with docs docker-mailserver#4492 (comment)
polarathene
reviewed
Jun 2, 2025
polarathene
approved these changes
Jun 2, 2025
Member
polarathene
left a comment
There was a problem hiding this comment.
Sorry about the delay, I spent the last few days verbosely documenting a related observation but with rDNS behaviour (when relying on our advised --hostname, which OVERRIDE_HOSTNAME approach was not affected by).
I've manually updated your PR with changes I wanted to wrap this up, so LGTM now 👍
Thanks for contributing to the project and helping it improve for other users 😁
Contributor
|
Documentation preview for this PR is ready! 🎉 Built with commit: 37b2a5f |
9 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changed the description of OVERRIDE_HOSTNAME environment variable, to raise awareness of unforeseen side effects.
Description
The current documentation of
OVERRIDE_HOSTNAMEinmailserver.envdoesnt reflect the fact that setting this can lead to unforeseen problems. See explanation at the bottom of this comment #4484 (comment)When setting up DMS the first time i thought it would be better to set it to make sure all internal services use the correct hostname. When in reality its better not to set this unless you need to.
While at it i reformated the text so it looks more like the rest of the comments in the file. Now with no trailing whitespaces.
Type of change
Checklist
docs/)I dont think this is necessary since the documentation already tells to only set this when you cant change the hostname.
No tests necessary, since this only changes a comment.
No tests necessary, since this only changes a comment.
CHANGELOG.md