Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs: Account “github-backend” #5264

Merged
merged 2 commits into from
Apr 13, 2021
Merged

Update Docs: Account “github-backend” #5264

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f592fb
Update Docs: Account “github-backend”
stephlocke Apr 13, 2021
25d8962
Update website/content/docs/github-backend.md
erezrokah Apr 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions website/content/docs/github-backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: GitHub
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.

Because Github [requires a server](https://github.com/netlify/netlify-cms/issues/663#issuecomment-335023723) for authentication, Netlify facilitates basic GitHub authentication.
Expand All @@ -17,6 +16,8 @@ To enable basic GitHub authentication:
backend:
name: github
repo: owner-name/repo-name # Path to your GitHub repository
# optional, defaults to master
# branch: main
```

## Specifying a status for deploy previews
Expand Down