static-cms/website/content/docs/github-backend.md

26 lines
1.1 KiB
Markdown
Raw Normal View History

2022-09-30 11:39:35 -04:00
---
group: Accounts
weight: 30
title: 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.
2022-10-02 20:06:20 -04:00
Because Github [requires a server](https://github.com/StaticJsCMS/static-cms/issues/663#issuecomment-335023723) for authentication, Netlify facilitates basic GitHub authentication.
2022-09-30 11:39:35 -04:00
To enable basic GitHub authentication:
1. Follow the authentication provider setup steps in the [Netlify docs](https://www.netlify.com/docs/authentication-providers/#using-an-authentication-provider).
2022-10-02 20:06:20 -04:00
2. Add the following lines to your Static CMS `config.yml` file:
2022-09-30 11:39:35 -04:00
```yaml
backend:
name: github
repo: owner-name/repo-name # Path to your GitHub repository
# optional, defaults to master
# branch: main
```
## Git Large File Storage (LFS)
2022-10-02 20:06:20 -04:00
Please note that the GitHub backend **does not** support [git-lfs](https://git-lfs.github.com/), see [this issue](https://github.com/StaticJsCMS/static-cms/issues/1206) for more information.