78. pepsi-settings¶
Manage per-address stage option overrides.
78.1. Role¶
pepsi-settings is the operator’s tool for the pepsi.settings table,
which overrides a stage’s [stage-<name>] options for messages to or from a
particular envelope address (the INI value remains the default). It connects
through the shared [pepsi-postgres] section and has no configuration of its
own. The shared stage code consults the table transparently (see
pepsi-dispatch); this tool lets an administrator edit rows directly. It is
not a stage. Started as root, it reads the configuration and any
import input file and then continues as the pepsi service account before
it connects, so no sudo -u pepsi is needed.
Reference: pepsi-settings(1).
Each row maps one lower-cased envelope address to a JSON object
{ "stage-<name>": { OPTION: value, … } }. The relevant address is the
envelope sender for locally-originated mail (state.local_origin),
otherwise an envelope recipient, matched exactly. When one inbound message’s
recipients resolve to different overrides for the stage about to run, the
pipeline splits it into one row per distinct override group.
78.2. Features¶
set ADDRESS STAGE OPTION VALUE — set one option override (the stage label is stored as the section key
stage-<name>, which must exist in the configuration; the value is parsed by the stage like its INI value).unset ADDRESS STAGE [OPTION] — remove one option, or the whole stage section; empty sections and rows are dropped automatically.
import ADDRESS SOURCE — replace an address’s whole object from a JSON file (
-for standard input).get / list — print one address’s settings, or all rows (
--json).remove — delete an address’s row entirely.
pepsi-setup validates the table after installing the schema: top-level
keys must be real [stage-<name>] sections and option values must be JSON
scalars.
Every change this tool makes is written to the audit log (address and option,
never the value). An override cannot replace a stage’s PROGRAM,
NEXT_STAGE or BOUNCE_STAGE, but it can override every other option that
the stage reads, branch targets included. This table is the user-writable layer
of the configuration and its boundary is described in Per-address settings are a trust boundary. A
login reassigned to a new owner loses the previous owner’s rows
(A login that changes owner).
78.3. See also¶
pepsi-dispatch, pepsi-stage-check-whitelist, pepsi-stage-edit-settings, pepsi-setup, Architecture, pepsi-settings(1), pepsi.conf(5).