summaryrefslogtreecommitdiff
path: root/docs/guides/auth/github.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/auth/github.md')
-rw-r--r--docs/guides/auth/github.md36
1 files changed, 19 insertions, 17 deletions
diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md
index d16b486f..dc46f74c 100644
--- a/docs/guides/auth/github.md
+++ b/docs/guides/auth/github.md
@@ -1,10 +1,11 @@
-Authentication guide - GitHub
-===
+# 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:
![create-oauth-app](../../images/auth/create-oauth-app.png)
@@ -17,19 +18,20 @@ Authentication guide - GitHub
![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`:
- ```js
- {
- "production": {
- "github": {
- "clientID": "3747d30eaccXXXXXXXXX",
- "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX"
- }
+ - `config.json`:
+ ```js
+ {
+ "production": {
+ "github": {
+ "clientID": "3747d30eaccXXXXXXXXX",
+ "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX"
}
}
- ```
- * environment variables:
- ```sh
- CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX
- CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX
- ````
+ }
+ ```
+
+ - environment variables:
+ ```sh
+ CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX
+ CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX
+ ````