gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Docs “authentication-backends”

Browse Source
This commit is contained in:
Shawn Erquhart 2018-04-23 20:17:27 +00:00
parent 7a0e136449
commit ca7f6e549e
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
website/site/content/docs/authentication-backends.md
View File

@ -17,14 +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 1. Head over to the [Netlify Identity docs](https://www.netlify.com/docs/identity) and follow the
steps to get started. steps to get started.
2. Add the following lines to your `config.yml` file: 2. Add the following lines to your `config.yml` file:
```yaml ```yaml
backend: backend:
name: git-gateway name: git-gateway
accept_roles: #optional - accepts all users if left out accept_roles: #optional - accepts all users if left out
- admin - admin
- editor - editor
``` ```
3. Optionally, you can assign roles to users in your Netlify dashboard, and then limit which 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. 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. Otherwise `accept_roles` can be left out, and all Netlify Identity users on your site will have access.
@ -49,22 +49,23 @@ To enable it:
1. Follow the authentication provider setup steps in the [Netlify 1. Follow the authentication provider setup steps in the [Netlify
docs](https://www.netlify.com/docs/authentication-providers/#using-an-authentication-provider). docs](https://www.netlify.com/docs/authentication-providers/#using-an-authentication-provider).
2. Add the following lines to your `config.yml` file: 2. Add the following lines to your `config.yml` file:
```yaml ```yaml
backend: backend:
name: github name: github
repo: owner-name/repo-name # Path to your Github repository repo: owner-name/repo-name # Path to your Github repository
``` ```
### External OAuth Clients ### External OAuth Clients
If you would like to facilitate your own OAuth authentication rather than use Netlify's service, you 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! 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 | | 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) | | [@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) | | [@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) | | [@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. Check each project's documentation for instructions on how to configure it.