github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-25 20:01:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/guides/auth/github.md
Sheogorath 3251bcbadc
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>
2018-06-01 14:36:33 +02:00

1.3 KiB
Raw Blame History

Authentication guide - GitHub

  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

  1. Fill out the new OAuth application registration form, and click Register Application

register-oauth-application-form

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

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

application-page

  1. 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: 
      HMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX
HMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX