Add a configuration reference page - #91
Open
benrfairless wants to merge 5 commits into
Open
benrfairless wants to merge 5 commits into
benrfairless wants to merge 5 commits into
Conversation
New feature pages written from the 3.3.7 source: - Routing incoming e-mail: MX vs forwarding address, route name rules, the five route modes and their SMTP-time behaviour, additional endpoints, processing order, HTTP/SMTP/address endpoint options (including the STARTTLS/STARTLS mismatch), retries and bounces - Mail server settings: Live/Development, retention behaviour and defaults, send limits (rolling hour, 90% warning, hourly notices), every reason a message can be held and whether release bypasses it, suppression list rules, advanced/admin-only settings, suspension, deletion - Sending domains: org vs server domains, DNS and e-mail verification, the four DNS checks with exact expected records and statuses, DKIM signing and fallback, custom return path for DMARC alignment, use_for_any
Documents the install-repo helper script: run/setup/tool commands, flags, override files and hooks.
Generated from doc/config/yaml.yml at the 3.3.7 tag (111 options across 17 sections) with environment variable names derived using the GROUP_KEY convention, plus cross-references to the relevant feature pages.
This was referenced Sep 15, 2026
willpower232
requested changes
Sep 18, 2026
willpower232
left a comment
willpower232
left a comment
Contributor
There was a problem hiding this comment.
can you deal with the conflicts in your PRs and I'll have a look?
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
2 participants
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.
Adds Getting Started → Configuration reference: a table of every configuration option in Postal 3.3.7 (111 options across 17 sections) with its default value, description and the environment variable that sets it.
The table was generated from
doc/config/yaml.ymlat the3.3.7tag. Environment variable names follow theGROUP_KEYconvention used by the config loader (e.g.main_db.host→MAIN_DB_HOST). A number of options have short additional notes and cross-references to the relevant feature pages.This means users no longer need to leave the docs and read the raw YAML on GitHub to find out what an option does or what its default is. The upstream files are still linked from the page.
Stacked on #90 (it links to pages added there); the diff will shrink to the single new file once that is merged.
pnpm generatepasses on this branch (177 routes prerendered, no 404s from the link crawler).