Merge branch 'fix/input-validation' into fix/fable-mediums
This commit is contained in:
commit
b2f447f875
1 changed files with 902 additions and 76 deletions
12
README.md
12
README.md
|
|
@ -10,7 +10,9 @@ A modern, single-binary mailing list manager: an evolution of Mailman.
|
|||
and a background worker sends it with retries (1m, 5m, 15m, 1h, 3h, then every 6h, for up to
|
||||
3 days). Relay outages and restarts lose nothing.
|
||||
- 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.
|
||||
send to `list+join@domain` or `list+leave@domain`, then reply to the confirmation. A reply works once, a request
|
||||
expires after 72 hours, and a confirmation that could not be applied (closed list, database error) can be replied to again.
|
||||
A member disabled by bounces can rejoin the same way.
|
||||
- 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 within 30 days disable a member.
|
||||
- Archive with full-text search (SQLite FTS5) and threading. Each list has an
|
||||
|
|
@ -41,12 +43,18 @@ Three listeners, each configurable:
|
|||
| `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.
|
||||
the unsubscribe links in every message use it. It must be an `https://` URL (RFC 8058 one-click unsubscribe needs
|
||||
it; `http://` is accepted only for `localhost`, `127.0.0.1` and `::1`) with a host and no credentials, query or fragment;
|
||||
the daemon refuses to start otherwise. Leave it empty to turn the one-click links off. 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
|
||||
```
|
||||
|
||||
A list `name` is 1 to 30 characters of `a-z`, `0-9`, `.`, `_` and `-` (upper case is lowered, no dot at either end), the `domain`
|
||||
a host name, and the `title` one line of at most 200 characters without control characters; anything else is a 400.
|
||||
The title is encoded (RFC 2047) in the `List-Id` header when it is not ASCII.
|
||||
|
||||
## Command line
|
||||
|
||||
The same binary is an administration client. It talks to the REST API, so it works against a local or remote daemon.
|
||||
|
|
|
|||
Loading…
Reference in a new issue