summaryrefslogtreecommitdiff
path: root/docs/guides/auth/github.md
diff options
context:
space:
mode:
authorSheogorath2018-03-20 14:44:01 +0100
committerSheogorath2018-06-01 14:36:33 +0200
commit3251bcbadc7721c771e19e81e7043dde4afe7cc9 (patch)
tree1dcd814bdbe4b956b80acf9425a5071c329bcfdf /docs/guides/auth/github.md
parent2ed2a08f6603cfdd144a4be9cfab0653f5e887d5 (diff)
Split authentication guides into multiple documents
Splitting the documentation should provide an easier access to the documentation people searching for and result in less merge conflicts when adding new documentation here. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
Diffstat (limited to 'docs/guides/auth/github.md')
-rw-r--r--docs/guides/auth/github.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md
new file mode 100644
index 00000000..62910cb2
--- /dev/null
+++ b/docs/guides/auth/github.md
@@ -0,0 +1,36 @@
+Authentication guide - GitHub
+===
+
+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)
+
+4. Fill out the new OAuth application registration form, and click **Register Application**
+
+![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)
+
+6. Add the Client ID and Client Secret to your config.json file or pass them as environment variables
+ * config.json:
+ ````javascript
+ {
+ "production": {
+ "github": {
+ "clientID": "3747d30eaccXXXXXXXXX",
+ "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX"
+ }
+ }
+ }
+ ````
+ * environment variables:
+ ````
+ HMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX
+ HMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX
+ ````