hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 15:33:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

address review in services doc

Browse Source
This commit is contained in:
Min RK
2021-05-26 09:19:02 +02:00
parent 3270bc76af
commit 4a0fed1a5b
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/reference/services.md
View File

@@ -90,8 +90,9 @@ c.JupyterHub.load_roles = [
{ {
"name": "idle-culler", "name": "idle-culler",
"scopes": [ "scopes": [
"users:servers", "read:users:activity", # read user last_activity
# also 'admin:users' if culling idle users as well "users:servers", # start and stop servers
# 'admin:users' # needed if culling idle users as well
] ]
} }
@@ -283,8 +284,8 @@ If you don't want to use the reference implementation
(e.g. you find the implementation a poor fit for your Flask app), (e.g. you find the implementation a poor fit for your Flask app),
you can implement authentication via the Hub yourself. you can implement authentication via the Hub yourself.
JupyterHub is a standard OAuth2 provider, JupyterHub is a standard OAuth2 provider,
so you can any OAuth 2 implementation appropriate for so you can use any OAuth 2 client implementation appropriate for your toolkit.
See the [FastAPI example][] for an example of using JupyterHub as an OAuth provider with fastapi, See the [FastAPI example][] for an example of using JupyterHub as an OAuth provider with [FastAPI][],
without using any code imported from JupyterHub. without using any code imported from JupyterHub.
On completion of OAuth, you will have an access token for JupyterHub, On completion of OAuth, you will have an access token for JupyterHub,
@@ -356,4 +357,5 @@ section on securing the notebook viewer.
[hubauthenticated]: ../api/services.auth.html#jupyterhub.services.auth.HubAuthenticated [hubauthenticated]: ../api/services.auth.html#jupyterhub.services.auth.HubAuthenticated
[nbviewer example]: https://github.com/jupyter/nbviewer#securing-the-notebook-viewer [nbviewer example]: https://github.com/jupyter/nbviewer#securing-the-notebook-viewer
[fastapi example]: https://github.com/jupyterhub/jupyterhub/tree/HEAD/examples/service-fastapi [fastapi example]: https://github.com/jupyterhub/jupyterhub/tree/HEAD/examples/service-fastapi
[fastapi]: https://fastapi.tiangolo.com
[jupyterhub_idle_culler]: https://github.com/jupyterhub/jupyterhub-idle-culler [jupyterhub_idle_culler]: https://github.com/jupyterhub/jupyterhub-idle-culler