From eaeb88401d07687eb3db8c273f7a4c0ed31ec153 Mon Sep 17 00:00:00 2001
From: Tilman Vatteroth
Date: Mon, 4 Jan 2021 13:07:44 +0100
Subject: Move docs into subdirectory to make mkdocs work in a subdirectory

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
---
 docs/content/guides/auth/github.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 docs/content/guides/auth/github.md

(limited to 'docs/content/guides/auth/github.md')

diff --git a/docs/content/guides/auth/github.md b/docs/content/guides/auth/github.md
new file mode 100644
index 00000000..f540a530
--- /dev/null
+++ b/docs/content/guides/auth/github.md
@@ -0,0 +1,35 @@
+# 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-hedgedoc-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`:
+    ```js
+    {
+      "production": {
+        "github": {
+          "clientID": "3747d30eaccXXXXXXXXX",
+          "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX"
+        }
+      }
+    }
+    ```
+
+  - environment variables:
+    ```sh
+    CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX
+    CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX
+    ````
-- 
cgit v1.2.3