Documentation

Rustango-CMS Documentation

Guides for the people who edit a Rustango-CMS site and the developers who build one — step by step, with a picture of every screen.

View the source on GitHub

Start here

• What is Rustango-CMS? Goal: understand what Rustango-CMS is, the three ways it gives you to make pages — from fixed pages made in code to free pages that editors build… Read →
• Getting started: build a blog with rustango-cms This walkthrough takes you from an empty directory to a working blog with an editor's admin: a page tree, two page types, a Markdown body stored in its… Read →
• Run Rustango-CMS in production Goal: put a Rustango-CMS site on a server: secrets, database, domains, media, caching, search, the scheduler and email — and know what to back up. Read →
• Headless JSON API The read API a decoupled frontend consumes: pages, the site's structure, and the navigation menus — localized, and filtered to what the caller is allowed… Read →
• Per-tenant templates A multisite needs its tenants to look different without differing in code. Each tenant can override any public template from its own directory, falling… Read →

For editors

• How to find your way around the admin Goal: know where things are in the admin, so you can find what you need. Read →
• How to create and publish your first page Goal: make a home page and show it to visitors. Read →
• How to use the live preview Goal: see how your page looks while you write it — on a computer, a tablet and a phone. Read →

Build a ceramics shop

• Build a ceramics shop, step by step Goal: see what you will build in this guide, and in what order. Read →
• Your shop's name and colours Goal: type your shop's name, tagline, colours and footer text in one place. Every page of the shop uses them. Read →
• Add your photos Goal: upload all your photos to the media library in one go, so you can use them on any page. Read →
• The home page Goal: make the front page of the shop: a big photo, a heading over it and a short welcome text. Read →
• Make a "Product" page type Goal: decide which boxes every product has — a price, a glaze, a photo and a description. You do this in the admin, without code. Read →
• Groups of products: categories Goal: make four groups — Tea bowls, Vases, Jars and Bowls — so visitors can find products by group. Read →
• The shop page Goal: make the page that shows all your products. The products go under this page in the next chapter. Read →
• Add your products Goal: add your products under the shop page, each with a price, a glaze, a photo, a description and a category. Read →
• The main menu Goal: build the menu at the top of every page. You add pages and your own links, change the order, and put items inside other items. Read →
• Reusable text: write it once, show it everywhere Goal: write the shipping information once, show it on the "About us" page and on every product page, and change it in one place. Read →
• The order form: let customers order a piece Goal: build an order form, put it on a product page, receive an order by email and read it in the admin. Read →
• Be found on Google Goal: help Google and social networks show your shop well: good titles and descriptions, share images, a sitemap, and no broken links after you rename a… Read →
• A second language Goal: show the shop in French too: the pages, the menu, the shipping text and the order form. Read →
• A members area Goal: show a Trade prices page only to cafés and shops that buy from you, and let them sign up on the site. Read →
• Work as a team Goal: let a helper, Mia, add products to the shop, and check each product yourself before visitors see it. Read →
• A sale Goal: prepare a Winter sale page now, and let the site publish it on 1 December at 9:00 and take it down on 8 December at 18:00 — without you being there. Read →
• Let an AI agent help Goal: give an AI assistant its own key, so it can write new product pages for you as drafts. You read them and publish them yourself. Read →
• Show menus and settings in templates Goal: show the editors' menus and settings on the site, the way the Clay & Kiln shop does it. Read →
• The helper traits Goal: understand the parts of the Clay & Kiln shop that are made in Rust, and make your own. Read →
• A headless storefront Goal: show the Clay & Kiln shop on a second website that you write yourself. The CMS keeps the content; your site only asks for it and decides how it… Read →
• Preview drafts on your own frontend Goal: let editors see a draft in the headless storefront — inside the page editor and in a new tab — before anybody else can. Read →