Local vs GitHub: storage strategy
Keystatic currently has two strategies for its content generation: github and local.
GitHub strategy
In most cases where external collaboration from contributors is anticipated, the github approach will make more sense: it enables anyone with a GitHub account (and “write” rights on the repo) to make commits, create branches and open Pull Requests for content changes.
This strategy requires your project to be on an existing GitHub repository.
In your Keystatic config, you can set the storage strategy to github like so:
// Keystatic config
import { config } from '@keystatic/core'
export default config({
storage: {
kind: 'github',
repo: {
owner: YOUR_REPO_OWNER,
name: YOUR_REPO_NAME
}
}
})
When you visit the /keystatic route in the browser for the first time with the github storage strategy, you will be invited to create or configure a GitHub app:
If you click on the “Create GitHub App” button, you will be taken to GitHub and asked for a name for your App.
Once you create it, you should see this screen:
Click on “Install GitHub App” and give it access to your repo:
If you look at your project, a new .env file should have been created with some Keystatic environment variables:
# Keystatic
KEYSTATIC_GITHUB_CLIENT_ID=...
KEYSTATIC_GITHUB_CLIENT_SECRET=...
KEYSTATIC_SECRET=...
PUBLIC_KEYSTATIC_GITHUB_APP_SLUG=...If you visit /keystatic one more time, you should see the Keystatic dashboard!
You know the github strategy is working if you see the GitHub-related UI elements (branch selector, GitHub contextual dropdown menu, branch list).
Local strategy
The local strategy is much simpler than the github strategy, but it's more limiting in its collaboration capabilities.
If you're a solo dev or a team that only wants to use Keystatic while running it locally, the local strategy might be great for you!
You don't need a GitHub App to run that strategy. You don't need a GitHub account at all, actually. The content files are generated on inside your local project directly.
In your Keystatic config, you can set the storage strategy to local like so:
// Keystatic config
import { config } from '@keystatic/core'
export default config({
storage: { kind: 'local' }
})
That's it!
You will notice there are no signs of GitHub-related UI elements in the Keystatic Admin UI:
