Merge pull request #1252 from netlify/cms/authentication-backends
Automatically generated. Merged on Netlify CMS.
This commit is contained in:
Shawn Erquhart
GitHub
commit
ea338ba51f
@ -2,11 +2,12 @@
|
||||
title: Authentication & Backends
|
||||
position: 25
|
||||
---
|
||||
|
||||
# Authentication & Backends
|
||||
|
||||
Netlify CMS stores content in your GitHub repository. (GitLab and Bitbucket coming soon!) In order for this to work, you need to authenticate with GitHub, and that requires a server. We have a few options for handling this.
|
||||
|
||||
**Note:** some static site generators have plugins for optimized integration with Netlify CMS, and starter templates may utilize these plugins. If you're using a starter template, read the template documentation before proceeding, as their instructions may differ.
|
||||
|
||||
## Git Gateway with Netlify Identity
|
||||
|
||||
[Git Gateway](https://github.com/netlify/git-gateway) is a Netlify open source project that allows you to add editors to your site CMS without giving them direct push access to your GitHub repository. [Netlify Identity](https://www.netlify.com/docs/identity/) service handles the authentication and provides a simple interface for user management. The Netlify CMS [featured templates](https://www.netlifycms.org/docs/start-with-a-template) are working examples of this backend.
|
||||
@ -16,16 +17,14 @@ To use it in your own project, follow these steps:
|
||||
1. Head over to the [Netlify Identity docs](https://www.netlify.com/docs/identity) and follow the
|
||||
steps to get started.
|
||||
2. Add the following lines to your `config.yml` file:
|
||||
|
||||
``` yaml
|
||||
backend:
|
||||
name: git-gateway
|
||||
accept_roles: #optional - accepts all users if left out
|
||||
- admin
|
||||
- editor
|
||||
|
||||
```
|
||||
|
||||
```yaml
|
||||
backend:
|
||||
name: git-gateway
|
||||
accept_roles: #optional - accepts all users if left out
|
||||
- admin
|
||||
- editor
|
||||
|
||||
```
|
||||
3. Optionally, you can assign roles to users in your Netlify dashboard, and then limit which
|
||||
roles can access the CMS by defining the `accept_roles` field in the `config.yml` example above.
|
||||
Otherwise `accept_roles` can be left out, and all Netlify Identity users on your site will have access.
|
||||
@ -50,28 +49,26 @@ To enable it:
|
||||
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 `config.yml` file:
|
||||
|
||||
``` yaml
|
||||
backend:
|
||||
name: github
|
||||
repo: owner-name/repo-name # Path to your Github repository
|
||||
```
|
||||
|
||||
```yaml
|
||||
backend:
|
||||
name: github
|
||||
repo: owner-name/repo-name # Path to your Github repository
|
||||
```
|
||||
|
||||
### External OAuth Clients
|
||||
|
||||
If you would like to facilitate your own OAuth authentication rather than use Netlify's service, you
|
||||
can use one of the community-maintained projects below. Feel free to [submit a pull request](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md) if you'd like to add yours!
|
||||
|
||||
|
||||
| Author | Supported Git hosts | Languages | Link |
|
||||
|------------------------------------------------|---------------------------|-----------|------------------------------------------------------------------------------|
|
||||
| [@vencax](https://github.com/vencax) | GitHub, GitHub Enterprise | Node.js | [Repo](https://github.com/vencax/netlify-cms-github-oauth-provider) |
|
||||
| [@igk1972](https://github.com/igk1972) | GitHub, GitHub Enterprise | Go | [Repo](https://github.com/igk1972/netlify-cms-oauth-provider-go) |
|
||||
| [@davidejones](https://github.com/davidejones) | GitHub, GitHub Enterprise | Python | [Repo](https://github.com/davidejones/netlify-cms-oauth-provider-python) |
|
||||
| Author | Supported Git hosts | Language(s)/Platform(s) | Link |
|
||||
| ---------------------------------------------- | ------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [@vencax](https://github.com/vencax) | GitHub, GitHub Enterprise | Node.js | [Repo](https://github.com/vencax/netlify-cms-github-oauth-provider) |
|
||||
| [@igk1972](https://github.com/igk1972) | GitHub, GitHub Enterprise | Go | [Repo](https://github.com/igk1972/netlify-cms-oauth-provider-go) |
|
||||
| [@davidejones](https://github.com/davidejones) | GitHub, GitHub Enterprise | Python | [Repo](https://github.com/davidejones/netlify-cms-oauth-provider-python) |
|
||||
| [@marksteele](https://github.com/marksteele) | GitHub, GitHub Enterprise | Serverless | [Repo](https://github.com/marksteele/netlify-serverless-oauth2-backend), [Blog](https://www.control-alt-del.org/blog/serverless-blog-howto/) |
|
||||
|
||||
Check each project's documentation for instructions on how to configure it.
|
||||
|
||||
|
||||
## Bitbucket and GitLab Support
|
||||
|
||||
Netlify CMS is meant to be platform agnostic, so we’re always looking to expand the ecosystem and
|
||||
@ -88,11 +85,11 @@ Both `git-gateway` and `github` backends allow some additional optional fields f
|
||||
cases. A full reference is below. Note that these are properties of the `backend` field, and should
|
||||
be nested under that field.
|
||||
|
||||
| Field | Default | Description |
|
||||
|----------------|-------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `repo` | none | **Required** for `github` backend; ignored by `git-gateway`. Follows the pattern `[org-or-username]/[repo-name]`. |
|
||||
| `accept_roles` | none | `git-gateway` only. Limits CMS access to your defined array of user roles. Omitting this field gives access to all registered users. |
|
||||
| `branch` | `master` | The branch where published content is stored. All CMS commits and PRs are made to this branch. |
|
||||
| `api_root` | `https://api.github.com` (ignored for `git-gateway` backend) | The API endpoint. Only necessary in certain cases, like with GitHub Enterprise. |
|
||||
| `site_domain` | `location.hostname` (or `cms.netlify.com` when on `localhost`) | Sets the `site_id` query param sent to the API endpoint. Non-Netlify auth setups will often need to set this for local development to work properly. |
|
||||
| `base_url` | `https://api.netlify.com` | OAuth client URL for the `github` backend. **Required** when using an external OAuth server with the `github` backend. |
|
||||
| Field | Default | Description |
|
||||
| -------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `repo` | none | **Required** for `github` backend; ignored by `git-gateway`. Follows the pattern `[org-or-username]/[repo-name]`. |
|
||||
| `accept_roles` | none | `git-gateway` only. Limits CMS access to your defined array of user roles. Omitting this field gives access to all registered users. |
|
||||
| `branch` | `master` | The branch where published content is stored. All CMS commits and PRs are made to this branch. |
|
||||
| `api_root` | `https://api.github.com` (ignored for `git-gateway` backend) | The API endpoint. Only necessary in certain cases, like with GitHub Enterprise. |
|
||||
| `site_domain` | `location.hostname` (or `cms.netlify.com` when on `localhost`) | Sets the `site_id` query param sent to the API endpoint. Non-Netlify auth setups will often need to set this for local development to work properly. |
|
||||
| `base_url` | `https://api.netlify.com` | OAuth client URL for the `github` backend. **Required** when using an external OAuth server with the `github` backend. |
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user