Start with a working site, then choose the reference guide for the part you want to change. These links cover prebuilt installation, custom themes, integrations, and server operations.

New in v0.31.0: editor formatting survives sanitized saves, search uses readable page text, and administrators can link to a public status page. Read the release overview and upgrade checks before updating an existing site.

Follow the getting started path

New installation? Follow these four guides in order. Each one links to the next step.

  1. Install — choose your platform and verify the release.
  2. Configure — review settings, paths and generated keys.
  3. Publish — prepare, preview and publish your first page.
  4. Deploy — run the site as a service behind HTTPS.

Start here

  • Build your first site

    Publish a page, customize the Tiny Sample theme, and prepare a small project for deployment.

  • Download and install

    Choose a supported platform, verify the release archive, and follow the local quick start. Go and Node.js are not required to run a prebuilt binary.

  • Editor's guide

    Prepare drafts, add images, preview and publish content, and maintain linked translations.

Guides by topic

  • Configuration

    Understand .env and environment precedence, preserve generated keys, and configure local and production installations.

  • Publish in two languages

    Build a linked English and Russian About page, translate navigation and metadata, and check both public versions.

  • Build a contact form

    Choose fields, test validation, configure hCaptcha, and review or export saved submissions.

  • Theme gallery

    Preview the bundled themes on desktop and mobile, then choose and activate a starting point.

  • Theme customization

    Add menus, editable settings, widget areas and versioned assets to your own HTML theme.

  • API cookbook

    Read content, check a scoped key, create a draft, and upload media with practical curl examples. Explore the interactive API reference and REST API guide for the full contract.

  • Deployment

    Run the binary as a service, configure HTTPS through a reverse proxy, and check a production installation.

  • Account security

    Set up an authenticator, keep recovery codes, choose account roles, and understand administrator recovery.

  • Backup and restore

    Keep a consistent SQLite snapshot, uploads, configuration and matching binary, then rehearse a restore in a separate installation.

  • Upgrade walkthrough

    Stage a verified release, rehearse with a restored copy, back up the site, replace the binary and recover the complete old installation if needed.

Additional references

Read with an AI assistant

The AI documentation index links to focused Markdown guides. Append .md to a supported guide URL, such as configuration.md, or request its original URL with Accept: text/markdown. Guides use the current published CMS content. The complete homepage and Download guide in Markdown include the theme's sections and all three platforms' installation commands; these two representations are generated from the full rendered pages.

The AI resource catalog describes the public guides and REST discovery endpoints. In browsers that support WebMCP, assistants can use search_ocms_docs to find guides by title, topic and summary, and read_ocms_guide to read their Markdown. These browser tools read public content without a key and make no changes. The ordinary site and Search remain available in other browsers.

Public reading needs no key. The access guide explains owner-issued API keys and the authenticated MCP endpoint. See the API catalog and live OpenAPI schema for the actual API contract. The crawler policy allows search and AI-assisted browsing while disallowing model training.

Read the release history for published changes and upgrade pointers. Downloads continue to follow the latest stable release.

Need a hand? Get help with oCMS for troubleshooting links, version and health checks, contact options and a copyable bug-report template.

The GitHub Wiki contains the full reference, including Go module development and theme templates. Follow the blog for release notes and practical guides.

Source: https://ocms.tech/docs