maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
docbrown/docs/backend/auth-github.md
rhymes 9210f6793b Improvements on dev docs (#2616) 
* Correct installation documentation

* Add stylized titles

* Add some changes to the getting started documentation

* Add changes for the backend guide

* Add changes for the design guide

* Add testing / Q&A guide improvements

* Minor fixes to contributing docs

* More improvements to the general doc

* Improvements for frontend guide
2019-04-29 18:54:29 -04:00

1.6 KiB
Raw Blame History

title
GitHub Authentication

GitHub App and Authentication

DEV 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. Sign in in your GitHub account.

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

    github-1

  3. You will be redirected in 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. You will need a personal token as well. From the same dashboard, navigate to Personal access tokens and generate a new token.

    github-3

  5. Fill in the token description and generate the token.

  6. Be sure that you copy the token right away, because it is the only time you will see it. Change it accordingly.

    Personal access tokens -> GITHUB_TOKEN

    github-4

  7. Done.