Using KeyStatic in the Next.js Supabase SaaS Starter Kit

To use Keystatic, you need to set the CMS_CLIENT environment variable to keystatic. This is the default value, so you don't need to do anything.

CMS_CLIENT=keystatic

Storage kinds

Keystatic can be used in two ways:

1. Local storage: the content is loaded directly from the file system.
2. GitHub storage: the content is loaded from a Github repository. This is best for collaborative content editing or if using Cloudflare.

Local storage

Keystatic uses the local storage kind by default. It is easy to get started with and requires no additional setup. Perfect for personal projects.

NEXT_PUBLIC_KEYSTATIC_STORAGE_KIND=local # local, cloud, github
KEYSTATIC_PATH_PREFIX=apps/web
NEXT_PUBLIC_KEYSTATIC_CONTENT_PATH=./content

Depending on whether you use the local or github storage kind, you may need to change the value of NEXT_PUBLIC_KEYSTATIC_CONTENT_PATH (see below).

GitHub storage

You can also use Keystatic Cloud or GitHub as the storage kind as remote storage.

If KEYSTATIC_STORAGE_KIND is set to cloud, the following environment variables are required:

NEXT_PUBLIC_KEYSTATIC_STORAGE_KIND=cloud
KEYSTATIC_STORAGE_PROJECT=project-id

If KEYSTATIC_STORAGE_KIND is set to github, the following environment variables are required:

NEXT_PUBLIC_KEYSTATIC_STORAGE_KIND=github
NEXT_PUBLIC_KEYSTATIC_STORAGE_REPO=makerkit/next-supabase-saas-kit-turbo-demo
KEYSTATIC_PATH_PREFIX=
NEXT_PUBLIC_KEYSTATIC_CONTENT_PATH=./apps/web/content
KEYSTATIC_GITHUB_TOKEN=github_**********************************************
KEYSTATIC_PATH_PREFIX=apps/web

Of course, you need to replace the NEXT_PUBLIC_KEYSTATIC_STORAGE_REPO and KEYSTATIC_GITHUB_TOKEN with your own values.

GitHub token

The KEYSTATIC_GITHUB_TOKEN is a Github token with read permissions to the repository, which you can generate from the Github Developer Settings in your account.

Note: the Github token must have permissions to read to the repository (for read-only).

GitHub mode

GitHub mode requires the installation of a GitHub app for displaying the admin.

Please refer to the Keystatic documentation for more information.

If your content folder is not at content, you can set the NEXT_PUBLIC_KEYSTATIC_CONTENT_PATH environment variable to the correct path. For example, if your content folder is at data/content, you can set the NEXT_PUBLIC_KEYSTATIC_CONTENT_PATH environment variable as:

NEXT_PUBLIC_KEYSTATIC_CONTENT_PATH=apps/web/data/content

Adding the Keystatic admin to your app

To add the Keystatic admin UI to your app, please run the following command:

turbo gen keystatic

Your app will now have a new route at /keystatic where you can manage your content.

Note: your Github token must have permissions to read to the repository (for read-only).

Note: by default, the Keystatic admin is only available in a development environment. For production environments, please add some sort of authentication. For example, use the isSuperAdmin function to check if the user is a super admin and allow them to access the Keystatic admin.