- 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
68 lines
2.7 KiB
Markdown
68 lines
2.7 KiB
Markdown
# parsimony
|
|
|
|
A modern, single-binary mailing list manager: an evolution of Mailman.
|
|
|
|
- Postfix delivers to parsimony over LMTP; parsimony relays through SMTP.
|
|
- Discussion lists with member-only posting, `List-*` headers, one-click unsubscribe
|
|
and DMARC-safe `From` rewriting.
|
|
- Self-service subscribe and unsubscribe by email with double opt-in:
|
|
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`).
|
|
- Admin web UI (Vite, React, shadcn/ui) served by the API listener at `/`: lists, settings,
|
|
members, held queue and archive.
|
|
|
|
## Run
|
|
|
|
```
|
|
cp parsimony.example.yaml parsimony.yaml
|
|
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
|
|
```
|
|
|
|
## Admin UI
|
|
|
|
The UI is a single-page app in `admin/`, built into `internal/adminui/dist` and embedded in the binary.
|
|
It is served on the API listener together with `/api`, so it needs no CORS, and only when
|
|
`PARSIMONY_API_TOKEN` is set. You sign in with that token (kept in `sessionStorage`, gone when the tab closes).
|
|
|
|
```
|
|
make admin # npm ci && npm run build
|
|
make build # go build, embeds the UI
|
|
make test # go test + vitest
|
|
```
|
|
|
|
Without `make admin` the binary still builds and the UI answers 503 with a hint.
|
|
For frontend work run the daemon, then `cd admin && npm run dev` (Vite proxies `/api` to `127.0.0.1:8080`).
|
|
|
|
## Postfix
|
|
|
|
Deliver the list domains to parsimony over LMTP and keep the `+` extensions intact, for example:
|
|
|
|
```
|
|
transport_maps = hash:/etc/postfix/transport
|
|
# /etc/postfix/transport
|
|
lists.example.org lmtp:inet:127.0.0.1:2424
|
|
```
|