github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-27 03:58:02 -05:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/guides/auth/github.md
Sheogorath 97a08e7954
Add note about renaming to docs 
It's way easier to add a note to the guides than to redo all the images,
etc. We have more important things to spend our time on, but if someone
wants to redo them, you are very welcome!

Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-06-24 14:06:32 +02: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

  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