Commit graph parsimony/README.md
Author SHA1 Message Date
tgiachi
fa96a398ee docs: per-step delivery timeouts, trusted proxies and the confirmation cap
- Describe the phases of a delivery and the unknown-outcome retry
- Document web.trusted_proxies, the form's address rules and limits.pending_per_hour
2026-11-10 15:21:24 +01:00
tgiachi
c6cbcb3d3b docs: say what the second review found about newsletters, priority and shutdown
- Warn that forged publisher senders are not checked by the daemon
- Describe the real limits of the delivery priority
- Document the Docker stop timeout and three known gaps
2026-11-10 15:06:35 +01:00
tgiachi
275b269977 docs: Newsletters section in the README
- Publishers policy, sent-post statistics, priority, rate limit and the public subscribe form
- State what is not included: scheduled sends and open or click tracking
2026-11-10 13:07:16 +01:00
tgiachi
0ea96c28d9 docs: screenshots of the admin UI and the public archive in the README
- Add five screenshots taken from a demo instance: lists, moderation, archive, queue and a public thread
- Cropped to their content and optimised (about 740 kB in total)
2026-11-10 12:29:54 +01:00
tgiachi
1dddf14cfd feat: the logo in the admin UI, the README and as PNG exports
- Show the wordmark on the login page and the mark in the header; set the page title to Parsimony
- Put the logo at the top of the README, with a dark-mode variant
- Add PNG exports (a 512 px mark for avatars, a 1200 px wordmark), both transparent
- Say that the logo is under the same licence
2026-11-10 12:14:50 +01:00
tgiachi
b4f45035bb Merge branch 'fix/hygiene-cli-ui' into fix/fable-mediums
# Conflicts:
#	internal/router/m2_test.go
2026-11-10 12:01:40 +01:00
tgiachi
b2f447f875 Merge branch 'fix/input-validation' into fix/fable-mediums 2026-11-10 12:01:07 +01:00
tgiachi
5af20f5891 Merge branch 'fix/dup-and-shutdown' into fix/fable-mediums 2026-11-10 12:01:06 +01:00
tgiachi
d435f80297 docs: describe the duplicate guard and the graceful stop
- replace the sentence on at-least-once delivery with what is guarded
  now (a post queued once per list per hour, approvals always delivered)
- describe the 30 s graceful stop of LMTP and HTTP
- state what remains: at-least-once across the relay, and copies that
  arrive after an hour
2026-11-10 11:58:21 +01:00
tgiachi
eccd82af69 feat(cli): escape control characters from mail, refuse the token over plain http
- printable() shows C0, DEL and C1 control characters (except tab and newline; CRLF counts
  as a newline) as \xNN / \uNNNN, applied to every table cell, archive show, member
  listings, import reports and error text, so an escape sequence in a subject cannot
  drive the terminal.
- The client refuses to send the bearer token over http:// to a non-loopback host unless
  --insecure is given: usage error, exit 2. localhost, 127.0.0.0/8 and ::1 stay allowed.
  Offline commands (dkim) never build the client, so they are not affected.
- Tests: the helper, ESC sequences in archive ls/show, held ls, queue ls, list/member names,
  API errors and import reports; the URL check by flag and PARSIMONY_URL. README updated.
2026-11-10 11:57:58 +01:00
tgiachi
8151204a3d Merge branch 'fix/limits-timeouts' into fix/fable-mediums 2026-11-10 11:56:17 +01:00
tgiachi
19c7dbb9c2 Merge branch 'fix/bounce-accounting' into fix/fable-mediums 2026-11-10 11:56:17 +01:00
tgiachi
53ca30ad61 docs: list name, domain and title rules, confirmation behaviour
- openapi: name, domain and title constraints of POST /lists, title of PATCH
- README: the rules, the RFC 2047 List-Id, single-use and re-usable confirmation, rejoin after bounces
2026-11-10 11:54:52 +01:00
tgiachi
38552f8025 fix(app): add read, write and idle timeouts to the HTTP servers
- the API + admin UI server and the public web server get ReadTimeout 30s,
  WriteTimeout 60s and IdleTimeout 120s next to ReadHeaderTimeout
- the archive import extends its own read and write deadlines to 30
  minutes with http.ResponseController, so a big mbox is not cut
- tests: a stalled body and an idle connection are cut on both servers,
  an import longer than the default timeouts succeeds, fields are pinned
- README: document the limits and timeouts
2026-11-10 11:54:50 +01:00
tgiachi
9a64146fce fix(router): deliver automated posts, stop robots from confirming subscriptions
- discardReason drops only the own-List-Id loop, Auto-Submitted: auto-replied and Precedence: auto_reply; auto-generated, auto-notified and unknown values take the normal path (membership, From, moderation)
- join, leave and confirm commands ignore (250, token kept) a null sender, any Auto-Submitted other than no, Precedence auto_reply/bulk/junk and the list's own List-Id
- tests: loop_test, new auto_test, ingest LMTP test
- README: loops and robots paragraph in the security notes
2026-11-10 11:54:08 +01:00
tgiachi
f340078aed fix(config): check base_url at load
- config: empty is fine; otherwise https with a host, http only for localhost/127.0.0.1/::1, no
  userinfo, query, fragment or whitespace; the error names base_url
- test: accepted and refused URLs
- docs: README states the rule
2026-11-10 11:51:38 +01:00
tgiachi
8317e44338 docs: describe which bounce reports count and the 30-day window
- README: only RFC 3464 reports with Action: failed and a
  recipient-unknown code count; bounces count for 30 days.
- openapi: Member.disabled and bounce_count say the count is recent.
2026-11-10 11:51:17 +01:00
tgiachi
37241464a7 docs: held queue summary, bounds and the From header in the API and README 2026-11-10 11:42:42 +01:00
tgiachi
c1c8211c1b fix(outbound): count a missing mailbox only when RCPT TO says so
- Issue MAIL, RCPT and DATA one by one so a failure knows which command it answers
- Treat 5.1.1, 5.1.2, 5.1.3, 5.1.6 and 5.1.10 as 'no such mailbox' only in answer to RCPT TO
- A refused sender (5.1.x answering MAIL FROM) or a refusal after DATA keeps the delivery as failed and never strikes members
- Ignore a QUIT error once the relay accepted the message: it caused duplicate deliveries
2026-11-10 11:37:45 +01:00
tgiachi
a6601caed7 feat(app): send through the configured relay with TLS and authentication
- Read the relay password and CA file at startup; refuse to start on an unusable one
- Pass TLS mode, server name, CA pool, credentials and EHLO name to the SMTP relay
- Default the EHLO name to the host name
- Test an authenticating STARTTLS relay, a wrong password (mail stays queued) and the startup checks
- Document external relays in the README and the example config
2026-11-10 11:05:24 +01:00
tgiachi
2b66937ac7 fix(admin): type the held fixture, update the e2e token and LMTP allow list
- Add the reason field to a test fixture so tsc -b passes
- Use a 24+ character API token and an lmtp.allow list in the end-to-end stack
- Describe failed deliveries in the README
2026-11-09 20:35:54 +01:00
tgiachi
e4e08cd25e test(scale): measure big lists and big archives, document the numbers
- Add make scale: a 10000-member fan-out through the queue and a 50000-message import with search latencies
- Report the figures in the README
2026-11-09 20:32:09 +01:00
tgiachi
625d487eca fix(security): API token strength and brute-force lockout
- Refuse an API token under 24 characters or with whitespace at startup, without echoing it
- Lock an address out for 5 minutes after 10 wrong or missing tokens in 5 minutes (429 with Retry-After)
- Ignore X-Forwarded-For for the lockout, forget idle addresses
- Document both
2026-11-09 20:25:05 +01:00
tgiachi
eb9e915805 fix(security): hold posts whose From header does not match the sender
- Judge membership on the envelope sender and require the From header to name the same address
- Hold mismatches (and missing, unparsable or multiple From addresses) for the admin instead of delivering
- Record why a message was held: new held.reason column, migrated, shown in the API, CLI and UI
- Accept an empty message in the held queue
- Document who may post
2026-11-09 20:23:07 +01:00
tgiachi
064e8beed8 fix(security): LMTP allow list and a warning for an open LMTP port
- Add lmtp.allow: clients outside the list are dropped before the greeting (TCP only)
- Validate the list at load, naming the bad entry
- Warn at startup when LMTP is reachable beyond the machine and no list is set
- Stop publishing the LMTP port in the README and the example config; add Security notes
2026-11-09 20:20:35 +01:00
tgiachi
7ba07501c3 chore: Go 1.27.3, GPL-3.0-or-later licence, lint and vulnerability checks
- Require Go 1.27.3: fixes the standard library vulnerabilities govulncheck reported
- Add the GPLv3 text and the licence note
- Move shadcn to devDependencies: npm audit finds nothing in production dependencies
- Add make lint (staticcheck) to go-ci and a separate vuln job in CI
- Fix the staticcheck warning in a test
2026-11-09 20:18:57 +01:00
tgiachi
849a85ec7d feat: end-to-end DKIM check through a real Postfix, docs and example config
- Check that every message the list delivered through Postfix is signed with the list domain and still verifies, and that edits break it
- Run dkim keygen, record and the no-overwrite rule inside the read-only container
- Document DKIM, SPF and DMARC in the README and show the dkim block in the example config
2026-11-09 20:04:32 +01:00
tgiachi
b777acc154 feat: end-to-end test and docs for the archive import
- Import a Mailman-style mbox through the CLI inside the container: encoded headers, multipart, escaped From lines, threading, idempotence
- Check accent-insensitive search and the public page hiding addresses
- Document the migration from Mailman in the README and the endpoint in OpenAPI
2026-11-09 19:52:14 +01:00
tgiachi
64b7614db1 docs: describe the CI workflows and make ci 2026-11-09 17:04:40 +01:00
tgiachi
2d8b0ccce6 feat(cli): command-line client for administration
- Add parsimony list, member, held, archive and queue subcommands over the REST API
- Read the token only from PARSIMONY_API_TOKEN; take the URL from --url or PARSIMONY_URL
- Print tables by default and JSON with --json
- Add member import from a file or stdin, reporting failing lines and exiting non-zero
- Require --yes for destructive commands
- Add parsimony serve; keep the old -config invocation working
- Run the CLI inside the container in the end-to-end test
- Test every command against the real API handler; mutation checks over the CLI
2026-11-09 16:57:25 +01:00
tgiachi
9992a50ab9 test(e2e): run the whole path through a real Postfix in Docker
- Add a Postfix test image: relay domain handed to parsimony over LMTP, members in maildirs, unknown users rejected with 5.1.1
- Check list headers, VERP return path and per-recipient unsubscribe links on real delivered mail
- Check a real 5.1.1 disabling a member after three hard bounces, and a real LMTP 550 for non-members
- Check join and leave by email, moderation, the public archive and one-click unsubscribe
- Add make e2e behind the e2e build tag
2026-11-09 16:46:55 +01:00
tgiachi
ccb2940d6e build(docker): run as a non-root user with a read-only root filesystem
- Use the distroless nonroot image and USER 65532
- Make /data the only writable path, owned by the unprivileged user
- Read the config from /etc/parsimony/parsimony.yaml, mounted read-only
- Expose the three listener ports
- Document the run command in the README
2026-11-09 16:11:55 +01:00
tgiachi
6461e77a95 feat: document the queue, close mutation gaps, plain relay errors
- Document delivery semantics, retries and the queue API in the README and OpenAPI
- Add relay.concurrency to the example config
- Test that a relay problem never counts against a member, that the longest-waiting delivery goes first, and the error and limit details
- Show the plain relay error when there is a single batch
2026-11-09 16:04:45 +01:00
tgiachi
a0a083273c feat(admin): build tooling, Docker stage and docs; close test gaps
- Add Makefile (admin, build, test) and a node stage in the Dockerfile
- Add .dockerignore so host node_modules and builds stay out of the image
- Document the admin UI in the README
- Cover mutation survivors: token cleanup on non-401 failures, cache dropped on 401 and sign out, member filter by name, archive invalidated after approval, page offset
2026-11-09 15:42:07 +01:00
tgiachi
8f64ac671d feat: serve the public web from the daemon and document the archive
- Add web.listen config (default 127.0.0.1:8081, empty disables)
- Start the public web in app, close it with the rest
- Add end-to-end test: archive stays private, becomes public, hides addresses, one-click unsubscribe works
- Cover mutation survivors: attachments, first text part, multibyte cap, member id 0, page clamp, API limit cap, closing connections
- Update OpenAPI, README and example config
2026-11-09 15:22:50 +01:00
tgiachi
ad58789630 feat(api): list policies, held queue and member bounce state
- Add post_policy and join_policy to lists, patchable per field
- Add held message listing, approve and discard endpoints
- Expose disabled and bounce_count on members
- Reject '+' in list names, it is the command separator
- Wire the router release into the daemon
- Update OpenAPI description and README
2026-11-09 15:05:11 +01:00
tgiachi
1ba42316fd feat: wire REST API into the daemon and document it
- Add api.listen config; token comes from PARSIMONY_API_TOKEN
- Disable the API when the token is not set
- Add OpenAPI description and README usage
2026-11-09 14:57:57 +01:00
tgiachi
a5ea90dbee chore: initial project skeleton 2026-11-09 14:44:55 +01:00