RuntCMS Documentation

Welcome to the RuntCMS documentation. RuntCMS is a lightweight, self-hosted CMS that lets you edit your website content directly on the live page — just click and type.

This documentation covers version 0.9.

What is RuntCMS?

RuntCMS is designed for small websites where you want your clients or editors to be able to update content without learning a complex admin interface. There's no page builder, no block editor, no drag-and-drop. Editors log in and click directly on the text or images they want to change — the way the web used to work, but polished.

Key ideas:

• Inline editing — no separate editing view. The live site is the editor.
• HTML templates you control — write normal HTML. Add a few data-cms-region attributes where content should be editable.
• Revision history — every save is tracked. Restore any version in one click.
• Two user roles — Admins manage everything. Editors see the site and edit content only.

Documentation sections

Getting Started

Everything from server requirements to your first login.

• Installation — upload files, run the wizard, you're done
• Dashboard Tour — what you'll see after logging in
• Managing Pages — create, organise, and configure pages
• Managing Users — admin and editor accounts
• Settings — site name, robots.txt, email
• Two-Factor Authentication — TOTP and recovery codes

Editing Content

Guides for editors — how to use RuntCMS day-to-day.

• Editing Text — clicking, formatting, and saving
• Replacing Images — uploading new images inline
• Revision History — previewing and restoring older versions
• Changing Your Password — from the runtbar

Building Templates

For developers building the site templates.

• Directory Structure — where everything lives
• Template Tags — full reference
• Text Regions — editable text attributes
• Image Attributes — inline and background image editing
• Navigation Tag — auto-generated nav markup
• Partials — reusable HTML snippets
• Deployment — going live on shared hosting

A quick example

This is all you need in a template file to make a heading editable:

<h1 data-cms-region="hero-title">Welcome to our site</h1>

When an editor is logged in, clicking that heading opens an inline editor. They type, click Save, done.

At the bottom of the template, include the runtbar:

{cms:system:runtbar}

That's the core of RuntCMS.