Skip to content

Commit 4e1fb0b

Browse files
committed
Add note on Github auth to Readme
1 parent 8972787 commit 4e1fb0b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,15 @@ bundle && yarn
2121
2222
foreman start -f Procfile.dev
2323
```
24+
25+
## Github Authentication
26+
27+
We use Github for authentication. So you will need to register a new OAuth application on Github.
28+
29+
Please make sure you set the authorization callback URL correctly. With the default devise and omniauth settings, add `/users/auth/github/callback` to your root URL.
30+
31+
For example, here are the settings for an app running on localhost port 3000:
32+
33+
Once you've set up your Github app, Github will provide you with a Client ID and secret. You need to add these to your app's environment as `GITHUB_APP_ID` and `GITHUB_APP_SECRET`.
34+
35+
For development, the easiest way is to put them in your `~/.bash_profile`, start a new terminal window and restart your Rails server.

0 commit comments

Comments
 (0)