9210f6793b
* 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
38 lines
1.6 KiB
Markdown
38 lines
1.6 KiB
Markdown
---
|
|
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](https://github.com/settings/applications/new) 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.
|
|
|
|
|
|
|
|
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):
|
|
|
|
```text
|
|
Client ID -> GITHUB_KEY
|
|
Client Secret -> GITHUB_SECRET
|
|
```
|
|
|
|
|
|
|
|
4. You will need a personal token as well. From the same dashboard, navigate to **Personal access tokens** and generate a new token.
|
|
|
|
|
|
|
|
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.
|
|
|
|
```shell
|
|
Personal access tokens -> GITHUB_TOKEN
|
|
```
|
|
|
|
|
|
|
|
7. Done.
|