Skip to content

Configuration

The configuration format for zsmtp is not documented in this repository yet.

This page keeps the contract honest: operators need to know that configuration is part of the planned docs surface, but the site should not publish example files until the schema, defaults, and validation behavior are verified.

What configuration needs to describe

At minimum, the published configuration docs should explain:

  • listener addresses and ports
  • TLS certificates and key references
  • relay, routing, or delivery targets
  • authentication and access-control policy
  • queue, spool, and retention settings
  • observability outputs such as logs or metrics

What is intentionally missing

The site does not yet include:

  • a canonical config filename
  • example YAML, TOML, or JSON snippets
  • environment variable overrides
  • precedence rules between config files and flags

Those details should be added only after they can be copied from the implementation and tested against the real binary.

Documentation standard

When the config page is filled in, it should answer three questions clearly:

  1. what each field controls
  2. which fields are required versus optional
  3. which defaults have operational or security impact

Released under the BSD-3-Clause License