github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-01 16:11:57 -05:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/content/guides/auth/github.md
Tilman Vatteroth b386737d08
Move docs into subdirectory to make mkdocs work in a subdirectory 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

(cherry picked from commit eaeb88401d)
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 13:07:44 +01:00

1.4 KiB
Raw Blame History

Authentication guide - GitHub

Note: This guide was written before the renaming. Just replace HackMD with CodiMD in your mind 😄 thanks!

  1. Sign-in or sign-up for a GitHub account

  2. Navigate to developer settings in your GitHub account here and select the "OAuth Apps" tab

  3. Click on the New OAuth App button, to create a new OAuth App:
    create-oauth-app

  4. Fill out the new OAuth application registration form, and click Register Application
    register-oauth-application-form

    Note: The callback URL is /auth/github/callback

  5. After successfully registering the application, you'll receive the Client ID and Client Secret for the application
    application-page

  6. Add the Client ID and Client Secret to your config.json file or pass them as environment variables

    • config.json: 
      {
  "production": {
    "github": {
        "clientID": "3747d30eaccXXXXXXXXX",
        "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX"
    }
  }
}
    • environment variables: 
      CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX
CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX