docbrown/docs/backend/auth-github.md
Alexis Moody f4a10e4a44
[deploy] Adds a new admin setting for experience levels. (#10870)
* Adds a new admin setting for experience levels.

This is used in the post management UI to determine the range of experience. These values fallback to the ones we currently see in DEV, Total Newbies and Senior Devs. There is also a removal of the word coding when talking about experience level, since the context for each forem instance should be implied when referencing experience.

* Cleans up experience defaults

* Fixes instance_of usage
2020-10-16 12:40:25 -06:00

1.2 KiB

title
GitHub Authentication

GitHub App and Authentication

Forem allows you to authenticate using GitHub. To use this authentication method in local development, you will need to set up a GitHub App and retrieve its keys. Then you'll need to provide these keys to the Rails application.

  1. Click this link to create a new OAuth application in your Github account - you will be redirected to sign in to Github account if you have not already.

  2. Fill in the form with an application name, description, and the URL http://localhost:3000/. Replace the port 3000 if you run Forem on another port.

    github-1

  3. You will be redirected to the app's Developer settings. Here you will find the keys. Add them to your .env file accordingly (name of GitHub key -> name of our ENV variable):

    Client ID -> GITHUB_KEY
    Client Secret -> GITHUB_SECRET
    

    github-2

  4. Done.