docbrown/docs/backend/auth-github.md
Andrew Brown 30dcb23169 #2507 - refactor GitDocs documentation (#2595)
* #2507 - refactor GitDocs documentation

* #2507 - fix grammar and spelling errors
2019-04-29 10:08:22 -04:00

1.6 KiB

title
GitHub Authentication

GitHub App and Authentication

Dev.to allows you to authenticate using Github. To use this authentication method in local development, you will need to set up a GitHub App and retrieves keys. Then you'll need to provide theses keys to the Rails application.

  1. Sign in in your GitHub account.

  2. Fill in the form with an application name, descriptions and URLs http://localhost:3000/. Replace the 3000 port if you run DEV on other 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.