Papyr Write together in Markdown. The server can't read it. Try it GitHub

Plenum 0.1.0

Plenum is a small server for editing Markdown text together in real time, one Native AOT binary (x64 and arm64) with no database. Its clients merge the edits (Yjs) and encrypt them in the browser; the server numbers, stores and passes on the messages of a room and cannot read them. A sealed room’s link carries its secret; an open room’s name is its only key, so it is not private.

This is the first release. Before 1.0 anything may change between versions; the breaking changes of each release are listed in its notes.

Run it

docker run -d --name plenum --restart unless-stopped -p 8080:8080 -v plenum-data:/data ghcr.io/msallin/plenum:0.1.0

Open http://localhost:8080. Rooms need HTTPS (or localhost): docs/self-hosting.md goes on with Compose, Caddy, nginx or Traefik, TLS in Plenum itself, what to set on a public instance, backup and restore, upgrading, and coming from Etherpad.

What it does

  • Rooms: sealed (/r#s.<secret>, encrypted with a key from the link) and open (/r#<name>); the room page is an editor (CodeMirror) with a Markdown toolbar, a preview, the carets and colours of the others, recent rooms on the device, and import and export of .md, .txt and standalone HTML.
  • Limits and expiry: limits per source (address), a cap on stored rooms, and rooms that expire after a set time without a write. Every setting is in appsettings.json with its default and can be set by environment variable (docs/configuration.md).
  • Operation: an admin API and page behind a token (status, rooms, remove a room, metrics, an OpenAPI document), backup and restore, a health verb for container health checks, HTTPS from PEM files reloaded without a restart, traces and metrics through ActivitySource and Meter (docs/telemetry.md).
  • Hosting in your own app: AddPlenum, MapPlenumRelay and MapPlenumAdmin (docs/hosting.md, a sample in samples/).

What to change, coming from an earlier build of main

Only if you ran the server from main before this release:

  • Stored rooms of an earlier version are not read: the server does not start on their files and names them. Export the texts first (a room’s More, Export), remove rooms/*.log and rooms/*.snapshot, start the new image, import the texts. restore refuses older backups (docs/self-hosting.md, “Upgrading”).
  • Links of an earlier version open another, empty room. The endpoint is /relay: change a proxy rule on /relay/, and pass the request’s Host with its port or list the site’s origin in Plenum:Relay:AllowedOrigins.
  • The pages are / and /r; /m, /c, /b/ and the Blazor client are gone, and so is the redirect of old Etherpad links.
  • The admin token has a default file and a verb that makes it (docs/admin-api.md); a restore refuses a cut-off or expired backup.
  • The web root holds its files Brotli-compressed only.

The full list, with each commit’s own instructions, is in the release of v0.1.0 on the repository’s page.