Files
bongo/docs/setup-wizard.md
T
2026-07-18 15:26:16 +02:00

30 lines
1.7 KiB
Markdown

# Guided setup and configuration
Run `bongo-setup` (or `bongo-config wizard`) as root for a new installation.
The curses wizard asks deployment-level questions: server identity and hosted
domains, Web reverse proxy or direct-HTTPS mode, optional HAProxy mail
frontend, enabled mail protocols, internal port 26 relay, LDAP, legacy TLS
compatibility, and local mail scanners. Direct HTTPS asks for the certificate
chain and private-key paths, listens on 443, and reserves port 80 for the
automatic HTTPS redirect. Individual protocol limits retain safe defaults.
The admin password and generated configuration bundle are passed to
`bongo-config` through inherited anonymous file descriptors. They do not
appear in process arguments and no named password file is created.
The wizard probes clamd and spamd without modifying either service. A scanner
is enabled only after the expected `PONG` response. Loopback-only example
fragments are installed below `share/bongo/examples/antispam`; reverse proxy
examples are installed below `share/bongo/examples/reverse-proxy`.
For an installed server, use `bongo-admin config` to edit every Store, Web, and
LDAP configuration document. `bongo-admin config check` performs the same
cross-document plausibility checks without opening curses. Save validates all
documents together, serializes concurrent admin changes with a lock, uses
atomic replacement for local files, and rolls back prior writes if a later
write fails.
Configuration names such as `smtp`, `imap`, `antispam`, `antivirus`, and the
local `/etc/bongo/web` file have no `.json` suffix, although their contents
are JSON. The source and installed template names follow the same convention.