static-cms/website/content/docs/github-backend.md
2022-10-01 13:45:01 -04:00

1.0 KiB

group weight title
Accounts 30 GitHub

For repositories stored on GitHub, the github backend allows CMS users to log in directly with their GitHub account. Note that all users must have push access to your content repository for this to work.

Because Github requires a server for authentication, Netlify facilitates basic GitHub authentication.

To enable basic GitHub authentication:

  1. Follow the authentication provider setup steps in the Netlify docs.
  2. Add the following lines to your Simple CMS config.yml file:
backend:
  name: github
  repo: owner-name/repo-name # Path to your GitHub repository
  # optional, defaults to master
  # branch: main

Git Large File Storage (LFS)

Please note that the GitHub backend does not support git-lfs, see this issue for more information.