Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add config guide for relaying to and from a private DMS instance #3973

Merged

Conversation

furstblumier
Copy link
Contributor

@furstblumier furstblumier commented Apr 8, 2024

Description

This PR adds an example of how to setup a relay-only public instance of postfix to use with a private DMS instance.

Type of change

  • Improvement (non-breaking change that does improve existing functionality)
  • 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/)
  • 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

@georglauterbach georglauterbach added kind/new feature A new feature is requested in this issue or implemeted with this PR area/documentation labels Apr 11, 2024
@georglauterbach
Copy link
Member

LGTM 👍🏼 I would like to wait for @polarathene to review this too, though. Everyone is low on time currently, so it might take a bit. The effort is greatly appreciated, though! :)

- Public and Private instance/server references normalized to italicized  servers.
- Adopt admonitions for better scope and formatting.
- Revised or rewrote some sections, some content shuffled or repositioned.
- Added additional links to DMS doc pages and Postfix docs where relevant.
@polarathene polarathene changed the title add documentation for public relay docs: Setup guide for relaying to and from a private DMS instance Apr 16, 2024
@polarathene polarathene added this to the v14.0.0 milestone Apr 16, 2024
Copy link
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.

This looks pretty good, thanks for taking the time to contribute it!

Bit low on time for proper review cycle, so hope you don't mind with the direct commits I made. Please view the preview link to let me know what you think of the changes, if anything looks odd/off we can adjust, otherwise this seems good to merge 👍

I've not gone over the referenced discussion where I think I gave some other advice or cited some gotchas/alternatives to have in mind. So the guide could possibly be improved further but linking to the discussion at the top as I've added should be enough for anyone that lands on it 😅 might as well save ourselves some time until that extra information is useful to someone else.


Please update the CHANGELOG.md "Added" section to include this at the start of the list:

- **Docs:**
  - A guide for configuring a public server to relay inbound and outbound mail from DMS on a private server ([#3973](https://github.com/docker-mailserver/docker-mailserver/pull/3973))

@georglauterbach
Copy link
Member

ping @furstblumier

@furstblumier
Copy link
Contributor Author

Hi, sorry was pretty busy this week. Thanks a ton for the fixups, the markdown looks wayyyy better like this! :)
As said in my previous reply I'm ok with omitting that line, if that's the only thing that's bothering people.

casperklein
casperklein previously approved these changes Apr 21, 2024
@furstblumier

This comment was marked as resolved.

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
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.

Cheers @casperklein for the extra pass with corrections 😁

Thanks @furstblumier for the great contribution! 🎉

Copy link
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: 6701764

@polarathene polarathene merged commit df36051 into docker-mailserver:master Apr 21, 2024
3 checks passed
@polarathene polarathene changed the title docs: Setup guide for relaying to and from a private DMS instance docs: Add config guide for relaying to and from a private DMS instance Apr 21, 2024
@furstblumier furstblumier deleted the enhancement/mail-proxy branch April 22, 2024 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation kind/new feature A new feature is requested in this issue or implemeted with this PR service/postfix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants