Feature/website overhaul (#49)
* Reorganize repo * Overhaul website design and rewrite in NextJS and Typescript * Delete website-publish.yml
This commit is contained in:
committed by
GitHub
parent
3674ee5bd8
commit
421ecf17e6
25
website/content/docs/github-backend.mdx
Normal file
25
website/content/docs/github-backend.mdx
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: GitHub
|
||||
group: Accounts
|
||||
weight: 30
|
||||
---
|
||||
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](https://github.com/StaticJsCMS/static-cms/issues/663#issuecomment-335023723) for authentication, Netlify facilitates basic GitHub authentication.
|
||||
|
||||
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).
|
||||
2. Add the following lines to your Static CMS `config.yml` file:
|
||||
|
||||
```yaml
|
||||
backend:
|
||||
title: 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](https://git-lfs.github.com/), see [this issue](https://github.com/StaticJsCMS/static-cms/issues/1206) for more information.
|
Reference in New Issue
Block a user