alpha
Git CMS

Quickstart

Set up the Git CMS in 10 minutes. Pluto creates the GitHub App for you.

Git CMS in 10 minutes

Editors sign in to the admin with a GitHub App. You do not fill in the App settings by hand. Pluto sends the settings to GitHub, and GitHub creates the App after you confirm.

You need a GitHub repository for the content and a host with a server runtime, such as Vercel.

Deploy on Vercel

Deploy the site

Push the project to GitHub. Import the repository in Vercel and deploy. The site builds without any GitHub App value. The admin shows the setup checklist until the App exists.

Open the sign-in page

Open https://<your-site>/admin/login. The page shows the checklist Set up the GitHub sign-in.

Create the GitHub App

Select Create the GitHub App. Pluto opens GitHub with the App settings filled in. Confirm the name and select Create GitHub App.

Copy the environment variables

GitHub sends you back to your site. The result page shows a block of environment variables. Select Copy.

The block holds the secrets of the App. Pluto does not store it. Copy it before you leave the page.

Paste the block in Vercel

In Vercel, open Settings, then Environment Variables. Paste the block into the first field. Vercel reads the .env lines and fills the rows. Save.

Redeploy

Redeploy the project. The variables are run-time values, so the new deployment must start.

Install the App on the repository

Select the install link on the result page. Install the App on the content repository only. If you left the page, open /admin/login again. The checklist shows an Install the App link.

Sign in

Open /admin/login and select Sign in with GitHub. Users with push access to the repository can sign in.

After the redeploy, the setup routes answer 404. Nobody can create a second App on the live site.

Set up on your machine

In development, you do not need a GitHub App to edit. The dev server reads and writes the local content/ folder, and each save is a commit in your local Git repository. See Reference. Do the steps below to test the GitHub sign-in locally, or to test against the real repository.

Open the GitHub settings

Run bun run dev. Open Admin → Settings → GitHub.

Create the GitHub App

Select Create the GitHub App. Confirm on GitHub.

Restart the dev server

Pluto saves the values in the .env file of the project. The result page shows them too, so you can copy them to a host later. Restart the dev server so that it reads the new values.

Install the App

Install the App on the content repository. The settings page links to the install page.

Set PLUTO_GITHUB_STORAGE=github in .env to make the dev server use the GitHub repository. See Reference.

What next

  • The result page or the settings page shows a problem? See Troubleshooting.
  • Do you prefer to create the App by hand? See GitHub App.
  • Do you want to know every option and variable? See Reference.

Git CMS

Store Markdown content in a Git repository. Edit it in the Pluto admin. It works with local Git out of the box, and with GitHub to publish a deployed site. No database.

Reference

The plutoGithub options, the environment variables, and the private key formats.