Cumments¶
Cumments is a Matrix-native comment system. Comments are first-class Matrix events: comments, edits and deletes live in Matrix rooms, are stored by a projector into a local read model, and are exposed to websites through an HTTP API with async write submissions.
Matrix is the source of truth. SQLite is only a disposable read model:
cumments backfill rebuilds it from Matrix history.
Getting started¶
- Quick start — run the bundled tuwunel + Cumments stack and register the first site admin.
- Configuration — file discovery, environment variables and the full AppService example.
Concepts¶
- Architecture — the design philosophy (Matrix as truth, one write seam, disposable projection), how the API, reconciler, projector and AppService fit together, plus recovery.
- Data model — how Matrix events map to the typed comment model and its storage layout.
- Site trust — origin and HMAC write-path trust models, with a verification walkthrough for SSG sites.
- Site governance — site admins, managers and per-room moderators encoded in Matrix power levels, with token-DM verification.
Reference¶
- API — shared primitives, then per-area references for comments, sites, governance, operator and media.
- Problem types — the RFC 9457 error registry.
- CLI — local administration of sites, rooms, roles and backups.
Development¶
- Development — toolchain, checks and image builds.
- Demo frontend — the standalone browser demo page and identity model.
The OpenAPI contract lives at openapi.yaml and is validated
by CI (Redocly lint).