diff options
author | Claudius Coenen | 2019-04-01 01:31:05 +0200 |
---|---|---|
committer | GitHub | 2019-04-01 01:31:05 +0200 |
commit | a95f1e9f560d1d869db8d4289725ac9abb0e8939 (patch) | |
tree | d049536b0662c5677d19fc4ef228c5b98ba76849 /docs/guides/auth/github.md | |
parent | 3a0ff5edd3882cca3751bcfbca1843807ef0c7d7 (diff) | |
parent | ba6ede57bd32aae79bbcf41964777374620aeab0 (diff) |
Merge pull request #15 from ccoenen/feature/documentation-overhaul
Documentation overhaul
Diffstat (limited to 'docs/guides/auth/github.md')
-rw-r--r-- | docs/guides/auth/github.md | 31 |
1 files changed, 14 insertions, 17 deletions
diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md index d6a1095e..d16b486f 100644 --- a/docs/guides/auth/github.md +++ b/docs/guides/auth/github.md @@ -1,27 +1,24 @@ Authentication guide - GitHub === -***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* +**Note:** *This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* 1. Sign-in or sign-up for a GitHub account 2. Navigate to developer settings in your GitHub account [here](https://github.com/settings/developers) and select the "OAuth Apps" tab -3. Click on the **New OAuth App** button, to create a new OAuth App: +3. Click on the **New OAuth App** button, to create a new OAuth App: + ![create-oauth-app](../../images/auth/create-oauth-app.png) -![create-oauth-app](../images/auth/create-oauth-app.png) +4. Fill out the new OAuth application registration form, and click **Register Application** + ![register-oauth-application-form](../../images/auth/register-oauth-application-form.png) -4. Fill out the new OAuth application registration form, and click **Register Application** + **Note:** *The callback URL is <your-codimd-url>/auth/github/callback* -![register-oauth-application-form](../images/auth/register-oauth-application-form.png) - -*Note: The callback URL is <your-hackmd-url>/auth/github/callback* - -5. After successfully registering the application, you'll receive the Client ID and Client Secret for the application - -![application-page](../images/auth/application-page.png) +5. After successfully registering the application, you'll receive the Client ID and Client Secret for the application + ![application-page](../../images/auth/application-page.png) 6. Add the Client ID and Client Secret to your config.json file or pass them as environment variables - * config.json: - ````javascript + * `config.json`: + ```js { "production": { "github": { @@ -30,9 +27,9 @@ Authentication guide - GitHub } } } - ```` + ``` * environment variables: - ```` - HMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX - HMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX + ```sh + CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX + CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX ```` |