maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
docbrown/docs/backend/auth-github.md
Andy Zhao 955bdcb2bc
Update docs with Forem instead of dev.to (#9316) 
* Rename all GitHub links from thepracticaldev/dev.to to forem/forem

* Use new site name

* Rename to Forem

* Rename more dev.to to forem

* Remove unnecessary redirects

* Rename DEV to Forem

* Use Forem instead of DEV for branding

* Use Forem instead of DEV for licensing

* Use seedling instead of DEV logo
2020-07-15 13:29:11 -04:00

1.1 KiB
Raw Blame History

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. Change them accordingly (name of GitHub key -> name of our ENV variable):

    Client ID -> GITHUB_KEY
Client Secret -> GITHUB_SECRET

    github-2

  4. Done.