Skip to content

docs: Revise docs for the OVERRIDE_HOSTNAME ENV#4492

Merged
polarathene merged 10 commits intodocker-mailserver:masterfrom
s0ftcorn:patch-1
Jun 2, 2025
Merged

docs: Revise docs for the OVERRIDE_HOSTNAME ENV#4492
polarathene merged 10 commits intodocker-mailserver:masterfrom
s0ftcorn:patch-1

Conversation

@s0ftcorn
Copy link
Copy Markdown
Contributor

@s0ftcorn s0ftcorn commented May 26, 2025

Changed the description of OVERRIDE_HOSTNAME environment variable, to raise awareness of unforeseen side effects.

Description

The current documentation of OVERRIDE_HOSTNAME in mailserver.env doesnt 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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (non-breaking change that does improve existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

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/)
    I dont think this is necessary since the documentation already tells to only set this when you cant change the hostname.
  • If necessary, I have added tests that prove my fix is effective or that my feature works
    No tests necessary, since this only changes a comment.
  • New and existing unit tests pass locally with my changes
    No tests necessary, since this only changes a comment.
  • I have added information about changes made in this PR to CHANGELOG.md

s0ftcorn added 3 commits May 26, 2025 13:48
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
Comment thread mailserver.env Outdated
Comment thread CHANGELOG.md Outdated
@polarathene polarathene changed the title Update comments & documentation on OVERRIDE_HOSTNAME docs: Revise docs for the OVERRIDE_HOSTNAME ENV May 27, 2025
@polarathene polarathene added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels May 27, 2025
@polarathene polarathene added this to the v15.1.0 milestone May 27, 2025
Comment thread CHANGELOG.md Outdated
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

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

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 😁

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2025

Documentation preview for this PR is ready! 🎉

Built with commit: 37b2a5f

@polarathene polarathene merged commit e296eb4 into docker-mailserver:master Jun 2, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants