Skip to content
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.

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

small updates to auth docs #515

Merged
merged 5 commits into from
Feb 28, 2018
Merged

small updates to auth docs #515

merged 5 commits into from
Feb 28, 2018

Conversation

choldgraf
Copy link
Member

Makes GitHub first (since it's the easiest+most free of the auth steps) and adds a bit of extra information


.. note::

The org_whitelist is optional and will require users to accept the read:org github oath scope when logging in.
Copy link
Member

Choose a reason for hiding this comment

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

Typo in oath

@choldgraf
Copy link
Member Author

thanks for noticing @manics !!

@@ -52,7 +52,8 @@ Below is the structure to use in order to authenticate with GitHub.

.. note::

The org_whitelist is optional and will require users to accept the read:org github oath scope when logging in.
The org_whitelist is optional and will require users to accept the read:org github OAuth scope when
logging in.
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps a note here that it is not required if all the users membership is public

@choldgraf
Copy link
Member Author

great point @cam72cam !

@cam72cam
Copy link
Contributor

cam72cam commented Feb 22, 2018

That does not exactly address my concern, perhaps something like:

The org_whitelist section is optional, it lets you only allow users from particular GitHub organizations that you list. If you do not add the auth scope read:org, only users with public membership in the org will be allowed to log in. If it is not included, then all GitHub users will be allowed to access your JupyterHub.

@choldgraf
Copy link
Member Author

@cam72cam hmm - I'm actually a bit unclear as to what read:org means, and wasn't able to find options for this when creating a github OAuth app. Could you link to docs on what you're talking about here? Or more generally let me know what this means in more lay-person's terms?

@manics
Copy link
Member

manics commented Feb 23, 2018

@choldgraf I've got a related PR open: #523
Assuming this goes in I could either open a separate docs PR discussing org_whitelist and scope once this PR is merged in which case just leave your changes as they are, or I could give you a commit to cherry-pick here?

@choldgraf
Copy link
Member Author

Let's leave this open and you're welcome to suggest language here that I can add once you merge it in! That work for you?

@choldgraf
Copy link
Member Author

(just please remember to ping me when it's merged)

@cam72cam
Copy link
Contributor

@choldgraf read:org means that the application can lookup what organizations the user is a member of (both public and private memberships)

@manics
Copy link
Member

manics commented Feb 26, 2018

@choldgraf Suggested text in choldgraf#1

Explain auth.github.org_whitelist
@choldgraf
Copy link
Member Author

I love it @manics and @cam72cam - thanks for the patch and clarification. This PR is RTG from my end

@willingc willingc merged commit e0c42ef into jupyterhub:master Feb 28, 2018
@manics manics mentioned this pull request Aug 15, 2018
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants