-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Test Drive docs with Identity
- Loading branch information
1 parent
1f06885
commit a890e0d
Showing
3 changed files
with
18 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,28 @@ | ||
# Take a test drive | ||
|
||
You can easily try out Netlify CMS by running it on a pre-configured starter site. Our example in the [intro](/docs/intro) is the [Kaldi small business Hugo template](https://github.com/netlify-templates/kaldi-hugo-cms-template). Use the deploy button below to build and deploy your own copy of the repository: | ||
Netlify CMS can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify. Our example here is the [Kaldi coffee company template](https://github.com/netlify-templates/one-click-hugo-cms). Use the button below to build and deploy your own copy of the repository: | ||
|
||
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/kaldi-hugo-cms-template) | ||
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/one-click-hugo-cms&stack=cms) | ||
|
||
## Authenticate with GitHub | ||
After clicking that button, you’ll authenticate with GitHub and choose a repository name, then Netlify will automatically clone the template and deploy it, bringing you to the site dashboard when the build is complete. Next, you’ll need to set up Netlify's [Identity](https://www.netlify.com/docs/identity) service to authorize users to log in to the CMS. | ||
|
||
When the deploy completes, you can see your site, but in order to use the CMS, you'll need to set up authentication with GitHub. | ||
## Adding users | ||
|
||
First, register the site CMS as an authorized application with your GitHub account: | ||
|
||
1. Go to your account **Settings** page on GitHub, and click **Oauth Applications** under **Developer Settings** (or use [this shortcut](https://github.com/settings/developers)). | ||
2. Click **Register a new application**. | ||
3. For the **Authorization callback URL**, enter `https://api.netlify.com/auth/done`. The other fields can contain anything you want. | ||
1. From the Netlify site dashboard, select the **Identity** tab, and you'll find that there are no users yet. By default, this site is set to accept users by invitation only, and even the site owner needs to be invited. | ||
2. Select **Invite users**, enter your email address, and select Send. | ||
3. Check your email for the invitation. It will be sent from `no-reply@netlify.com`. | ||
|
||
![GitHub Oauth Application setup example](/img/github-oauth.png?raw=true) | ||
![Sample email subject line: You've been invited to join radiologist-amanda-53841.netlify.com](/img/email-subject.png?raw=true) | ||
|
||
When you complete the registration, you'll be given a **Client ID** and a **Client Secret** for the app. You'll need to add these to your Netlify project: | ||
|
||
1. Go to your [**Netlify dashboard**](https://app.netlify.com/) and click on your project. | ||
2. Click the **Settings** tab. | ||
3. Click on the **Access control** tab, then scroll down to **OAuth**. | ||
4. Under **Authentication providers**, click **Install Provider**. | ||
5. Select GitHub and enter the **Client ID** and **Client Secret**, then save. | ||
4. Click the link to accept the invite, and you’ll be directed to your new site, with a prompt to create a password. | ||
|
||
## Access the CMS | ||
!["Complete your signup" modal on the Kaldi coffee site](/img/create-password.png?raw=true) | ||
|
||
With the site deployed and authentication in place, you'll be able to enter the CMS by going to the URL of your new site and appending `/admin`. | ||
5. Enter a password, sign in, and you’ll be directed straight to the CMS! | ||
|
||
Try adding and editing posts, or changing the content of the Products page. When you save, the changes will be pushed immediately to GitHub, triggering a build on Netlify, and updating the content on your site. | ||
|
||
## More paths to explore | ||
- If you’d like to learn more about how it all works, check out the [Intro](/docs/intro). | ||
- To see how to integrate Netlify CMS into an existing project, go to the [Quick Start](/docs/quick-start). | ||
- If you’d like to change how users log in to your site, read up on [Netlify Identity service](https://www.netlify.com/docs/identity). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.