Skip to content

Commit 853e7cb

Browse files
committed
Add Github auth urls to readme
1 parent 4e1fb0b commit 853e7cb

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,15 @@ foreman start -f Procfile.dev
2424

2525
## Github Authentication
2626

27-
We use Github for authentication. So you will need to register a new OAuth application on Github.
27+
We use Github for authentication. So you will need to [register a new OAuth application on Github](https://github.com/settings/applications/new).
2828

2929
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.
3030

31-
For example, here are the settings for an app running on localhost port 3000:
31+
For example, in development, if your app is running on localhost port 3000, then the URL settings will be:
32+
33+
Homepage URL: `http://localhost:3000`
34+
35+
Authorization callback URL: `http://localhost:3000/users/auth/github/callback`
3236

3337
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`.
3438

0 commit comments

Comments
 (0)