Skip to content

Add support for github enterprise #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
everpcpc wants to merge 2 commits into from
Closed

Add support for github enterprise #145

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0515f87
Add support for github enterprise
everpcpc May 10, 2016
49562ca
Leave config empty and udpate readme
everpcpc May 12, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ For GitHub, follow these instructions (you need to be logged in in GitHub):
* Press the `Register application` button
* In the following page, on the top right corner, take note of the values for `Client ID` and `Client Secret`
* Now you need to copy the `Client ID` and `Client secret` in your jingo config file in the proper places
* Change `authorizationURL` `tokenURL` `userProfileURL` in the config file to your own url if you want to use github enterprise, or leave them empty

The _local_ method uses an array of `username`, `passwordHash` and optionally an `email`. The password is hashed using a _non salted_ SHA-1 algorithm, which makes this method not the safest in the world but at least you don't have a clear text password in the config file. To generate the hash, use the `--hash-string` program option: once you get the hash, copy it in the config file.

Expand Down
3 changes: 3 additions & 0 deletions lib/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ module.exports = (function () {
enabled: false,
clientId: "replace me with the real value",
clientSecret: "replace me with the real value",
authorizationURL: "leave me empty to https://github.com/login/oauth/authorize",
tokenURL: "leave me empty to https://github.com/login/oauth/access_token",
userProfileURL: "leave me empty to https://api.github.com/user",
Copy link
Owner

@claudioc claudioc May 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that for the default values, either you leave it really empty or you use those default URLs. The strings as they are, are a bit confusing, IMHO.

Copy link
Contributor Author

@everpcpc everpcpc May 12, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved the descriptions to readme

redirectURL: ""
Copy link
Owner

@claudioc claudioc May 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is also the concern of people using the github authentication, updating Jingo after we merge this PR, not updating their config file, and then probably failing the authentication because the default values of those fields are not a valid value.

Copy link
Contributor Author

@everpcpc everpcpc May 12, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tested an old config file without the new fields, enabled the github auth, It works well.

},
// @deprecated, use local with just an user
Expand Down
3 changes: 3 additions & 0 deletions routes/auth.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ if (auth.github.enabled) {
passport.use(new passportGithub({
clientID: auth.github.clientId,
clientSecret: auth.github.clientSecret,
authorizationURL: auth.github.authorizationURL,
tokenURL: auth.github.tokenURL,
userProfileURL: auth.github.userProfileURL,
callbackURL: redirectURL
},
function (accessToken, refreshToken, profile, done) {
Expand Down