Skip to content

Commit

Permalink
Merge pull request #221 from netlify/auth-instructions
Browse files Browse the repository at this point in the history
Added instructions to add GitHub as an auth provider
  • Loading branch information
cassiozen authored Jan 24, 2017
2 parents 8e26d5d + f991ee4 commit b6c5545
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,18 @@ Currently these widgets are built-in:
* **list** A list of items. Can have an inner `fields` attribute if each element is an object
* **hidden** Hidden element - typically only useful with a `default` attribute

### Authorizing GitHub as Provider

When you're setting up a new CMS configuration you will need to authorize GitHub as your provider. Here's how:

1. Go to your GitHub Settings page.
2. On the left menu, click “Oauth Applications”.
3. Create a new OAuth application (you can name it anything you want), authorization callback must be: `https://api.netlify.com/auth/done`.
4. Next, you need to go to your app settings on Netlify:
1. Go to “Access” menu.
2. On "Authentication Providers”, click “Install Provider”.
3. Choose “GitHub” and copy the "API Client ID” and "API Secret” that GitHub gave you when you created an Oauth application there.


## Extending Netlify CMS
The Netlify CMS exposes an `window.CMS` global object that you can use to register custom widgets, previews and editor plugins. The available methods are:
Expand Down

0 comments on commit b6c5545

Please sign in to comment.