codimd/docs/guides/auth/github.md

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:

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

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

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:

     HMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX
     HMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX