docs/content/guides/auth/github.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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`:
    ```json
    {
      "production": {
        "github": {
          "clientID": "3747d30eaccXXXXXXXXX",
          "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX"
        }
      }
    }
    ```

  - environment variables:
    ```shell
    CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX
    CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX
    ```