From 079b0c1b91f7db6ffe62244d7c74e0d19c3efe06 Mon Sep 17 00:00:00 2001 From: Min RK Date: Fri, 23 Feb 2018 13:44:07 +0100 Subject: [PATCH] feedback in README --- examples/external-oauth/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/examples/external-oauth/README.md b/examples/external-oauth/README.md index 5fa47c12..d3fb28d0 100644 --- a/examples/external-oauth/README.md +++ b/examples/external-oauth/README.md @@ -1,11 +1,13 @@ # Using JupyterHub as an OAuth provider -JupyterHub 0.9 introduces -Uses `jupyterhub.services.HubAuthenticated` to authenticate requests with the Hub. +JupyterHub 0.9 introduces the ability to use JupyterHub as an OAuth provider +for external services that may not be otherwise integrated with JupyterHub. +The main feature this enables is using JupyterHub like a 'regular' OAuth 2 +provider for services running anywhere. -There is an implementation each of cookie-based `HubAuthenticated` and OAuth-based `HubOAuthenticated`. +This example uses `jupyterhub.services.HubOAuthenticated` to authenticate requests with the Hub for a service run on its own host. -## Run +## Run the example 1. generate an API token: @@ -17,6 +19,8 @@ There is an implementation each of cookie-based `HubAuthenticated` and OAuth-bas 3. Launch JupyterHub: + jupyterhub + 4. Visit http://127.0.0.1:5555/ After logging in with your local-system credentials, you should see a JSON dump of your user info: