Documentation for Cumments v0.31.0.

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

Development

Cumments is backend/API infrastructure.

The visitor-facing frontend is maintained separately: https://github.com/Curious-r/cumments-web

The OpenAPI contract lives at /openapi.yaml and is validated by CI (Redocly lint).