Skip to content

Introduction

View as Markdown

Colophon is an open-source, self-hosted headless CMS. Editors write and publish in the Studio, a web app; websites and apps read published content as JSON from the delivery API; scripts, build tools and AI agents read and write through the management API, with the same permission checks the Studio uses.

What sets it apart is what happens after Publish. Every publish becomes a numbered release, and each release keeps a receipt: what went live, which website connections were told, and where the release was actually seen. If something is wrong, a rollback is just another release that puts earlier content back.

In a book, the colophon is the note at the back that records how, when and by whom it was printed. Colophon keeps that record for a website.

  • Editors write, preview, review and publish in the Studio, in plain words, without a terminal. Drafts save as you type, and a save that would overwrite someone else’s newer work is refused rather than lost.
  • Developers model content as content types, read it from any framework over HTTP, and automate with the colophon CLI, the TypeScript SDK or plain curl.
  • Scripts and agents get project API tokens that can do only what they are given, with an end date, optional rate and volume limits, and a revoke button that stops them at once. Agents can draft and propose changes, but can never approve their own work.
  • Operators run one server binary next to PostgreSQL, with a Docker compose file for a first install and a systemd + Caddy path for production.
Piece What it is Who uses it
Studio The web app at /studio/ on your server Editors, reviewers, owners
Delivery API GET /content/v1/{project}/{environment}/…: published content, no sign-in Your website or app
Management API /api/v1/…: everything the Studio can do, signed in or with an API token Scripts, build tools, the CLI, the SDK
GraphQL Read-only queries over drafts, for signed-in tools Developer tools
Live events Server-sent events that say content changed Sites that update without a rebuild
CLI, SDK, MCP server colophon, @colophon-cms/sdk, and an MCP server for AI agents Developers and agents

PostgreSQL is the only source of truth. The cache (Valkey) and object storage (S3-compatible, Garage in the quick start) make things fast and hold uploads; losing the cache never loses content or skips a permission check.

Was this page helpful?

Either answer opens a short issue on GitHub, so you can say what worked or what was missing.