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

add a small section for pre/post spawn hooks

Browse Source
This commit is contained in:
Carol Willing
2018-06-08 14:13:45 -07:00
parent 0f000f6d41
commit 3650575797
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/reference/authenticators.md
View File

@@ -208,7 +208,13 @@ class MyAuthenticator(Authenticator):
spawner.environment['UPSTREAM_TOKEN'] = auth_state['upstream_token'] spawner.environment['UPSTREAM_TOKEN'] = auth_state['upstream_token']
``` ```
## pre_spawn_start and post_spawn_stop hooks
Authenticators uses two hooks, [`pre_spawn_start(user, spawner)`] and
[`post_spawn_stop(user, spawner)`] to add pass additional state information
between the authenticator and a spawner. These hooks are typically used auth-related
startup, i.e. opening a PAM session, and auth-related cleanup, i.e. closing a
PAM session.
## JupyterHub as an OAuth provider ## JupyterHub as an OAuth provider