docs: PROXY protocol (Traefik) - Fix config typo#4483
docs: PROXY protocol (Traefik) - Fix config typo#4483polarathene merged 1 commit intodocker-mailserver:masterfrom
Conversation
When the entrypoints for traefik are defined there are named mail-*(smtp,...), but it the dms labels when it comes to using these entry point in the TLS section just smtp is used, and for TLS it is used smtp-submissions witch is an invalid entrypoint
|
Documentation preview for this PR is ready! 🎉 Built with commit: 423e90c |
There was a problem hiding this comment.
Pull Request Overview
This PR corrects the Traefik label entrypoint names in the mailserver-behind-proxy tutorial so they match the entryPoints defined in the TOML.
- Rename
smtp→mail-smtpfor STARTTLS configuration - Rename
smtp-submissions→mail-submissionsfor implicit TLS on port 465
Comments suppressed due to low confidence (1)
docs/content/examples/tutorials/mailserver-behind-proxy.md:122
- The tutorial defines a
mail-submissionentrypoint (port 587) in the TOML but doesn’t show its STARTTLS setup. Consider adding a snippet or note for configuring themail-submissionentrypoint similarly tomail-smtpfor completeness.
# Implicit TLS is no different, except for optional HostSNI support:
There was a problem hiding this comment.
Thanks for spotting this ❤️
I believe I noticed this too a few months back but got side-tracked before I PR'd a correction 😓
If you have any other feedback about that page please let me know.
I'm not a Traefik user myself, and there are a variety of ways to configure it. Is the labels approach most suitable/common? Or would our documentation be better for Traefik users if we documented a different config for readability/clarity instead of the labels?
For the most part many users have been mistakenly using that guide just because they have Traefik, but the focus is meant to be on PROXY protocol and solving a use-case there when that's actually required (Kubernetes ingress or other proxy layer between client and DMS).
This setup is quite a bit verbose, and only needed when routing traffic to DMS through a reverse proxy like Traefik. Since DMS should be the only mailserver instance using those ports, we tend to advise keeping it simple and just exposing the ports directly. DMS after all needs to terminate TLS itself so Traefik is rarely providing any added benefit like it would with your web services.
|
@georglauterbach @casperklein did either of you enable Copilot for the repo? Or is this something Github is rolling out itself? First time I've seen it engaging in our PRs. EDIT: Oh I see @casperklein requested it 😅 Well that's new to me. |
polarathene
added
area/documentation
area/configuration (file)
kind/bug/fix
polarathene
changed the title
polarathene
changed the title
|
Copilot was suggested as reviewer, so I gave it a try 👍 |
When the entrypoints for traefik are defined there are named mail-*(smtp,...), but it the dms labels when it comes to using these entry point in the TLS section just smtp is used, and for TLS it is used smtp-submissions witch is an invalid entrypoint
Description
I tried recreating the setup for DMS using traefik as a reverse proxy, but instead of writing the entrypoints in the docker compose file, i used the toml version to do this. Following the docs and translating the cli commands into the toml I got this:
............... entryPoints: mail-smtp: address: ":25" mail-submission: address: ":587" mail-submissions: address: ":465" mail-iamp: address: ":143" mail-imaps: address: ":993" mail-pop3: address: ":110" mail-pop3s: address: ":995" mail-managesieve: address: ":4190" ...............The code above is created based on this part of the docs
The problem arises when in the DMS labels because in the name of the entrypoints used aren't matching what is defined in the traefik configuration.
All i did is to change the name of the entrypoints for TLS and SSL to match what was declared.
Type of change
Checklist