parsimony/parsimony.example.yaml
tgiachi 8d28e48360 feat: configurable cap on confirmation requests, with a warning
When the global cap of unconfirmed requests (300 an hour) was reached,
a subscribe request silently got no mail while the visitor saw "Check
your email"; a newsletter launch can pass 300 signups an hour.

- limits.pending_per_hour (default 300, must be a whole number >= 1)
  is validated at load and set on the store by the app.
- When the global cap refuses a request the store logs a warning naming
  the setting, at most once a minute. The visitor still gets the
  neutral page, so nothing about members is revealed. The per-address
  cap is unchanged and is not logged.
- parsimony.example.yaml documents the setting.
2026-11-10 15:14:04 +01:00

35 lines
1.6 KiB
YAML

db: /data/parsimony.db
base_url: https://lists.example.org
lmtp:
network: tcp
addr: 0.0.0.0:2424
allow: [172.16.0.0/12] # LMTP has no authentication: list who may connect (here: the Docker networks)
relay:
addr: postfix:25
# To send through an external relay (SES, Mailgun, a smarthost) instead:
# addr: smtp.example.com:587
# tls: starttls
# username: user
# password_file: /run/secrets/relay-password
concurrency: 4 # simultaneous deliveries
# rate_per_second: 14 # at most this many sends started per second, for relays that throttle (Amazon SES); 0 = unlimited
web:
listen: 0.0.0.0:8081 # public archive and unsubscribe pages; "" disables them
# Reverse proxies (addresses or CIDR ranges) allowed to name the visitor in X-Forwarded-For, for
# the subscribe form's limit of 10 posts per hour per IPv4 address or IPv6 /64. Empty (the
# default): the TCP peer is the visitor and the header is ignored.
# trusted_proxies: [172.16.0.0/12]
api:
listen: 0.0.0.0:8080
# Each subscribe or unsubscribe request sends a confirmation mail. At most this many are accepted
# per hour, for all lists together (default 300); past it, requests get no mail and a warning is
# logged once a minute. Raise it before a newsletter launch.
# limits:
# pending_per_hour: 300
# The API token is read from the PARSIMONY_API_TOKEN environment variable.
# Sign outgoing mail with DKIM, one key per domain. The private key stays in a file
# (create it with: parsimony dkim keygen lists.example.org --selector mail).
# dkim:
# - domain: lists.example.org
# selector: mail
# key_file: /etc/parsimony/dkim-lists.pem