Running a site on Kiln.
You own the site. This page covers the day to day once Kiln is set up: signing in, deciding what can be edited, inviting people, publishing, undoing, billing, and leaving. Setting Kiln up is a separate job, covered in Get started for Kiln Cloud and in the Docs for Self-hosted.
What you will see
1The same door as your editors
Go to yoursite.com/kiln. On the sign-in card you choose Continue with GitHub, because the site's files live in a GitHub repository you control. Everyone you invite uses the Google button.
2The Kiln button and its menu
You land on your site with a round pencil button in the bottom right corner. Move the pointer onto it (on a phone, tap it) for the Kiln menu. Publish is at the top, and below it are the tools for this page and for the whole site. Two entries are yours alone: People & access and Suggestions. Two more, Make text/images editable and Add a gallery or events, are yours unless you give an editor the Make things editable tool.
3A notice when there is a newer editor
Kiln checks now and then whether a newer version of the editor exists and shows you, and only you, a small notice at the top of the page when one does. What to do about it depends on your plan. See “Keeping the editor up to date” below.
4If Astro builds your site
On a site Astro builds, Kiln edits the content files the pages come from, and your host, or GitHub when the site is on Kiln’s hosting, rebuilds the site after each publish, usually in a minute or two. The line at the bottom says Saved. The site is rebuilding with your change, then Published. Eleventy, Hugo and Jekyll sites can’t be edited this way yet. How a developer sets it up.
The things you will do
1Decide what can be edited
People can only change the parts of a page you have marked as editable. Open ✨ Make text/images editable in the Kiln menu. To start with the whole page at once, press Make this whole page editable in the bar at the top. Kiln first says how many pieces of text, pictures and lists of blocks it would mark, and marks them when you say yes. It is a first pass: it leaves tables, buttons and forms alone, and anything you have already marked, and a visitor sees no difference. It is saved at once, and the page reloads by itself when your site has the change. To mark by hand instead, or to adjust afterwards, click a heading, a paragraph, a picture or a list, and choose what it becomes. Click something that is already editable to switch editing off for it. The words stay; only the handle goes. Like everything else, these choices go live when you publish.
2Invite people
Open People & access in the Kiln menu and add a person by their Google email address. For each person you choose:
- Editor or Member. An editor changes the site. A member can only open your members-only pages and files. A members area has to be set up once before members have anything to open, and it needs the site to be on Kiln’s hosting or on Cloudflare Pages: the self-hosting guide has the steps for Pages, and on Kiln’s hosting Check this site on the site’s row says whether the members area is on. Members-only pages are kept in your GitHub repository like the rest of the site. Every editor you invite can read them, whichever pages you limit that editor to, and so can anyone at all if the repository is public. Use a private repository for a members area.
- How long a sign-in lasts. From 1 to 360 days, or never expiring. The form starts at 90. When it runs out they sign in again.
- For editors, which pages and sections. Leave both blank for the whole site. Everywhere else they see the page but cannot change it, and a note tells them which pages are theirs. The Kiln service holds each editor to the pages and sections you choose.
- For editors, which tools. Three are ticked to begin with: Page settings, History & restore and Save drafts. You can add New posts & pages, Schedule publishing, Edit site menu, Theme, Find & replace, Comments, Add sections and Make things editable. On a site you run yourself with an AI key on its Kiln service, there is one more: AI assist.
- Suggest-only publishing. Tick it and their Publish button becomes Suggest changes. Their changes wait under Suggestions in your menu, where you see a before and after and press Approve or Decline.
- Reviewer preset. A seat that can leave comments and change nothing.
One email address has one role on a site. Adding an address that is already on the list replaces the earlier entry, so making an editor a member takes their editing away.
Remove ends an editor's access at once, including a session they have open. A member you remove can no longer sign in, and a browser where they are already signed in loses access to the members pages within about five minutes.
Then send them the right page: the guide for editors or the guide for members.
3Publish, and review what others publish
You edit the same way your editors do, and the guide for editors describes it. You also have every tool you did not hand out: scheduling a publish for later, the site menu, find and replace, and the list of suggestions waiting for you. The Docs go through each one.
4Keeping the editor up to date
The editor is three files that sit in your site's assets folder. On Kiln Cloud the dashboard does it with you: when a new version is out, your site's row at app.kilncms.com says so, and Update Kiln shows what will change and then copies the new files in with one commit. On Kiln Cloud + hosting the new version is added to your site by itself about a day after it comes out, and the same button brings it sooner. On Self-hosted you bring it in yourself: open a terminal in the site's folder and run npx github:kilncms/kiln#release update. It copies the new files in and offers to commit and push them.
What happens when you press Publish
Changes to words and pictures are not live until someone publishes. A few tools save to the live site straight away, with no review sheet: Page settings, New posts & pages, Edit site menu, Theme, Find & replace, Add sections and Delete page. Publishing saves all the waiting changes on that page into the site's files in your GitHub repository as one commit, with the name of the person who made them. Your host sees the new commit and rebuilds the site. That usually takes under a minute.
Kiln then checks the live page itself. The line beside the Kiln button says Live ✓ once visitors can see the change, or Build failed, with a link to the commit, if the host could not build it. In that case the live site stays as it was.
How to undo a mistake
- Yours, before publishing. The Undo button beside the Kiln button, or Discard edits in the menu.
- Anyone's, after publishing. Open History & restore on that page. Every publish is listed with a name and a time. Undo this change takes back that one publish. Go back to this returns the whole page to how it was then. Both show you the result first and go live when you press Publish.
- One paragraph. Click into it and press the clock button on its toolbar to see that section's earlier versions.
- A person who should not have access. Remove them in People & access. For an editor it takes effect at once.
Every publish is a commit in your own repository, so nothing an editor does is hidden from you. Most changes can be undone in Kiln. A page that was deleted has to be restored from GitHub.
Your plan: the trial, billing, moving, leaving
The 7-day trial (Kiln Cloud and Kiln Cloud + hosting)
The 7 days start when you add your site in the Kiln dashboard. No card is needed, and editing works straight away. The Subscribe button on the site's row opens the checkout whenever you are ready. If you have not subscribed when the 7 days are up, the site's status changes to Canceled and editing switches off until you subscribe. Your site, your repository and everything already published are not touched. The 7 days belong to the site's address, so removing a site and adding it again does not restart them.
Billing and canceling
Payments are handled by Lemon Squeezy, our merchant of record. Once you have subscribed, Manage billing on the site's row opens their customer portal, where you change your card or cancel. Canceling stops the next renewal. The editor keeps working on your site to the end of the month you paid for, then stops. It never touches your site or your repository.
Remove on a site’s row cancels its subscription first, then takes the site off Kiln. If the cancellation cannot be confirmed, the site stays and the dashboard asks you to cancel through Manage billing.
What Kiln Cloud keeps about your site
- Your GitHub username, and the public email address on your GitHub profile if you have set one.
- Each site you add: its repository name, its address, the plan, its status, the date that address was first added, and its Lemon Squeezy subscription number once you subscribe.
- The list of people you invited: email address, name, role, and what each may edit.
- Comments and suggestions made in the editor, and changes scheduled for later.
- Sign-in sessions, yours and your editors'. Your dashboard session includes a GitHub access token for your account, kept for 30 days. It is how the dashboard checks that you are allowed to register a repository.
- A fingerprint of each API token you create, never the token itself.
Your pages are not on that list. They live in your GitHub repository.
Moving between plans
Your repository never moves. What you redo is the setup around it. Going from Kiln Cloud to Self-hosted you set up your own worker, register your own GitHub App, set up your own Google sign-in, point kiln-config.js at the new worker, and add your editors and members again. The list of people is kept with the worker, so it does not come with you, and neither do comments, suggestions, scheduled changes or API tokens. Going the other way is the same trip in reverse. Moving to or from Kiln Cloud + hosting also moves the hosting.
Leaving
Your content is plain HTML in your repository already. To remove Kiln, delete the two script tags from your pages (kiln-config.js and kiln.js). You can also delete the Kiln files (assets/kiln*.js and kiln.html) and uninstall the GitHub App from the repository. The site keeps working, with every edit anyone made still in it. Galleries, filters and calendars become plain lists, and a members area needs replacing.
Leaving Kiln’s hosting
On Kiln Cloud + hosting, Kiln also serves your site and keeps your domain’s records, so there is a little more to take with you. Press Moving away on the site’s row in the dashboard to see these steps with the buttons they name. Do these three steps in this order and nothing stops working on the way.
- Your site’s files. Your pages are in your repository. Connect it to any host that publishes from GitHub, and check the site there. If Kiln keeps this site’s files instead, press Download the site’s files and put them on your new host.
- Your domain’s records. Press Download the domain’s records and give the file to the company that will look after your domain next. It lists every record of your domain, your email records too.
- The name servers. At the company you bought the domain from, replace Kiln’s two name servers with the new company’s. Until you do, your site and your email keep working through Kiln. Kiln notices the change by itself and writes to you.
If Kiln forwards an address at your domain, that stops when the name servers change, so set that address up at the new company before step 3.
When the site is up at its new home, cancel under Manage billing, or press Remove on the site’s row. Download the domain’s records before you press Remove. After that the file is no longer in the dashboard.
If you only stop paying, nothing is switched off at once. Your site stays up on Kiln’s hosting for 30 days after the paid time ends, and Kiln writes to you twice before it comes down. Your domain’s other records, such as its email, are left working after that, until you move the domain.
If something goes wrong
- I signed in and there is no Kiln button
- That page does not load Kiln. Every page needs two script tags right before
</body>. On Kiln Cloud, press Added a page? Check for pages without Kiln on your site’s row in the dashboard, and Kiln offers to add them to the pages that lack them. If you used the setup command, it offered to add them to the pages it found; a page added later, or one where you said no, needs them pasted in. Get started has the two lines, under its heading about the terminal. - “Origin not allowed”
- On Kiln Cloud this means the site is not active: the trial ran out, or the subscription ended. A payment that failed keeps editing on for 7 days while the card is tried again. Check the site's status in the dashboard. It also appears when the address people are using differs from the one you registered, for example with and without
www. - “Kiln edits the HTML file for this page in your repo, but couldn't find one”
- The page you are looking at is produced by a build tool and is not stored in your repository as an HTML file. Kiln edits HTML files. See which sites work.
- An editor sees “You're not on the list (yet)”
- They signed in with a Google address that is not on your list. Add the address they actually use, exactly as they typed it.
- “Build failed”
- The change was saved to your repository, but your host could not build the site from it. Open the commit from the link in the message to see what was saved, then use History & restore to undo that change.
- Publish says it worked, and the live site never changes
- Your host is not rebuilding from the repository. Kiln saves to GitHub and relies on the host to pick the change up. Whoever set the site up can run
npx github:kilncms/kiln#release doctor, which checks exactly this. - I renamed or moved the repository
- Update
kiln-config.jsto the new name. Kiln knows a repository by its GitHub id, not its name, so what it stores for the site comes along: your people, comments, suggestions, scheduled changes and API tokens. On Kiln Cloud, check that the dashboard shows the site under its new name, and write to info@kilncms.com if it does not. - Who do I ask?
- Open an issue on GitHub, or write to info@kilncms.com. The full reference is in the Docs.
The short version.
Mark what is editable, add people by Google email, and send them their guide. Everything they publish is a commit in a repository you own, with a name on it, and you can undo any of it.