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
This commit is contained in:
parent
19c845caab
commit
8f64ac671d
1 changed files with 318 additions and 5 deletions
15
README.md
15
README.md
|
|
@ -9,6 +9,10 @@ A modern, single-binary mailing list manager: an evolution of Mailman.
|
|||
send to `list+join@domain` or `list+leave@domain`, then reply to the confirmation.
|
||||
- Moderated lists: posts wait in a queue that the API can approve or discard.
|
||||
- VERP bounces: every recipient gets a signed return address; 3 hard bounces disable a member.
|
||||
- Archive with full-text search (SQLite FTS5) and threading. Each list has an
|
||||
`archive_policy`: `private` (default, API only), `public` (web pages) or `off`.
|
||||
Public pages hide email addresses.
|
||||
- Per-recipient one-click unsubscribe links (RFC 8058) with signed tokens.
|
||||
- SQLite storage, one YAML config file.
|
||||
- Admin REST API under `/api/v1` (see `docs/openapi.yaml`).
|
||||
|
||||
|
|
@ -21,6 +25,17 @@ PARSIMONY_API_TOKEN=<token> go run ./cmd/parsimony -config parsimony.yaml
|
|||
|
||||
The API is disabled when `PARSIMONY_API_TOKEN` is not set.
|
||||
|
||||
Three listeners, each configurable:
|
||||
|
||||
| Listener | Default | Purpose |
|
||||
|----------|---------|---------|
|
||||
| `lmtp` | `127.0.0.1:2424` | mail from Postfix |
|
||||
| `api` | `127.0.0.1:8080` | admin REST API, bearer token |
|
||||
| `web` | `127.0.0.1:8081` | public archive and unsubscribe pages (`""` disables) |
|
||||
|
||||
Put the `web` listener behind a reverse proxy with TLS and set `base_url` to its public URL:
|
||||
the unsubscribe links in every message use it. Keep the `api` listener private.
|
||||
|
||||
```
|
||||
curl -H "Authorization: Bearer $PARSIMONY_API_TOKEN" -d '{"name":"dev","domain":"example.org","title":"Dev"}' localhost:8080/api/v1/lists
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue