README
¶
Gophenberg
A plugin-first CMS. Go backend exposing a JSON API, React SPA admin built on top of the WPDS and Gutenberg block editor.
What works today
- Block content authored in the Gutenberg editor, with autosave, revisions, trash and restore
- A posts list with status filters, counts and sorting, and a trash view
- Content types registered from the admin, each with its own addresses, archive, and optional nesting
- A media library storing uploads with derived image sizes, feeding the editor's media blocks from a picker and the inserter
- Session authentication with login rate limiting, and a users screen for administrators
- A public site at the root, the admin under
/admin, and a read-only content API at/api/content/v1 - Optional Astro themes through
@gophenberg/astro, with the built-in renderer taking over whenever no theme is active or a theme is down - Compile-time plugins owning routes, public paths, and their own schema, with a reference plugin serving the posts as an RSS channel
Running it locally
Go as pinned in go.mod, Node 26 with pnpm, and Docker for the PostgreSQL service.
cp .env.example .env
make seed
make seed starts PostgreSQL, applies the migrations, and creates a development
administrator (admin@example.com with the password password1234) alongside demo
content. Then run the API and the admin in two terminals:
make dev
pnpm install && pnpm --filter @gophenberg/frontend dev
The API listens on localhost:8081 and the admin on localhost:5174, which proxies
/api to the API.
To self-host a real deployment instead, follow the install guide.
Writing a theme
A theme is an Astro project depending on @gophenberg/astro. You write your layouts,
the kit supplies the routes and the block rendering. test/theme is a working example,
and writing a theme walks it.
Writing a plugin
A plugin is a Go package under plugins/ with a plugin.json, compiled in by
make generate. plugins/feed is the reference, and
write a plugin walks it.
Translating
The admin speaks whatever language its catalogues carry. Translation happens on POEditor, no Git needed, and a weekly job carries the finished work back in one batch. Translate Gophenberg walks it.
License
Copyright (C) 2026 Manuel 'SirLouen' Camargo
Gophenberg is free and open-source software under the
Apache License 2.0. Hand-written source files carry an
SPDX-License-Identifier: Apache-2.0 header.
Built frontend artifacts bundle @wordpress/* packages licensed under
GPL-2.0-or-later. Those combined bundles are conveyed under the terms of the
GPLv3, while all original source files in this repository remain Apache-2.0.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
doclint
command
Command doclint fails when any Go function under the module lacks a doc comment.
|
Command doclint fails when any Go function under the module lacks a doc comment. |
|
gophenberg
command
Command gophenberg runs the Gophenberg CMS server and the commands an operator runs beside it.
|
Command gophenberg runs the Gophenberg CMS server and the commands an operator runs beside it. |
|
pluginwire
command
Command pluginwire regenerates the plugin wiring files from the plugin.json manifest of every directory under plugins/.
|
Command pluginwire regenerates the plugin wiring files from the plugin.json manifest of every directory under plugins/. |
|
releasetool
command
Command releasetool makes release keys, signs and checks release files, lists them in SHA256SUMS and the release record, and writes the key list, the channel indexes and the timestamp file of the update site.
|
Command releasetool makes release keys, signs and checks release files, lists them in SHA256SUMS and the release record, and writes the key list, the channel indexes and the timestamp file of the update site. |
|
internal
|
|
|
accountbridge
Package accountbridge serves accounts to plugins over the sdk seam, never their email addresses.
|
Package accountbridge serves accounts to plugins over the sdk seam, never their email addresses. |
|
app
Package app runs the gophenberg command line and the site it serves over the plugins it is handed.
|
Package app runs the gophenberg command line and the site it serves over the plugins it is handed. |
|
content
Package content defines the content object at the center of the CMS.
|
Package content defines the content object at the center of the CMS. |
|
content/contenttest
Package contenttest runs one set of behaviour cases against any content, type, site setting or user setting store.
|
Package contenttest runs one set of behaviour cases against any content, type, site setting or user setting store. |
|
content/typestore
Package typestore runs the type store's steps over the statements any database engine lends it.
|
Package typestore runs the type store's steps over the statements any database engine lends it. |
|
contentbridge
Package contentbridge serves published content to plugins over the sdk seam.
|
Package contentbridge serves published content to plugins over the sdk seam. |
|
cron
Package cron runs named jobs once their interval has passed, each under a lease in a store.
|
Package cron runs named jobs once their interval has passed, each under a lease in a store. |
|
cron/crontest
Package crontest holds the cases every cron job store passes and an in-memory store that passes them.
|
Package crontest holds the cases every cron job store passes and an in-memory store that passes them. |
|
dbconns
Package dbconns reads the connection cap of the site's database handle, the same setting on either engine.
|
Package dbconns reads the connection cap of the site's database handle, the same setting on either engine. |
|
definitions
Package definitions carries the content definitions a plugin declares into the registry.
|
Package definitions carries the content definitions a plugin declares into the registry. |
|
i18n
Package i18n answers the words and dates a language reads on the public site.
|
Package i18n answers the words and dates a language reads on the public site. |
|
installer
Package installer sets up Gophenberg on a Linux server, which it reaches only through one Machine.
|
Package installer sets up Gophenberg on a Linux server, which it reaches only through one Machine. |
|
media
Package media defines the files the media library holds.
|
Package media defines the files the media library holds. |
|
media/mediatest
Package mediatest runs one set of behaviour cases against any media.Store.
|
Package mediatest runs one set of behaviour cases against any media.Store. |
|
mediahost
Package mediahost validates uploads and owns the media directory.
|
Package mediahost validates uploads and owns the media directory. |
|
postgres
Package postgres provides the PostgreSQL data layer for the CMS core.
|
Package postgres provides the PostgreSQL data layer for the CMS core. |
|
publichtml
Package publichtml prepares stored block content for public delivery.
|
Package publichtml prepares stored block content for public delivery. |
|
publicsite
Package publicsite renders published content as the built-in public site.
|
Package publicsite renders published content as the built-in public site. |
|
role
Package role names the roles a Gophenberg account holds and the capabilities they carry.
|
Package role names the roles a Gophenberg account holds and the capabilities they carry. |
|
seed
Package seed stores the demo data set a development database starts from.
|
Package seed stores the demo data set a development database starts from. |
|
served
Package served shapes a stored item the way every public seam answers it.
|
Package served shapes a stored item the way every public seam answers it. |
|
server
Package server exposes the CMS core over a JSON HTTP API.
|
Package server exposes the CMS core over a JSON HTTP API. |
|
signature
Package signature signs, checks and fingerprints release files in FAIR's wire format.
|
Package signature signs, checks and fingerprints release files in FAIR's wire format. |
|
sqlite
Package sqlite provides the SQLite data layer for the CMS core.
|
Package sqlite provides the SQLite data layer for the CMS core. |
|
sqlite/columns
Package columns holds the Go types SQLite columns read into and write from.
|
Package columns holds the Go types SQLite columns read into and write from. |
|
testdb
Package testdb provides fresh PostgreSQL test databases on the server GOPHENBERG_TEST_DATABASE_URL names.
|
Package testdb provides fresh PostgreSQL test databases on the server GOPHENBERG_TEST_DATABASE_URL names. |
|
themehost
Package themehost validates and runs the prebuilt theme artifacts a site is served from.
|
Package themehost validates and runs the prebuilt theme artifacts a site is served from. |
|
update
Package update checks a signed update site for newer Gophenberg versions and keeps what each check found.
|
Package update checks a signed update site for newer Gophenberg versions and keeps what each check found. |
|
updater
Package updater updates a server install: it unpacks a checked release, backs up the database and switches builds.
|
Package updater updates a server install: it unpacks a checked release, backs up the database and switches builds. |
|
version
Package version exposes application-wide metadata.
|
Package version exposes application-wide metadata. |
|
webui
Package webui holds the admin app the server serves, built in by release builds.
|
Package webui holds the admin app the server serves, built in by release builds. |
|
plugins
|
|
|
feed
Package feed serves the published posts as an RSS channel.
|
Package feed serves the published posts as an RSS channel. |
|
sdk
module
|
Click to show internal directories.
Click to hide internal directories.