Skip to content

Commit

Permalink
mention that auth_refresh_age = 0 disables time-based refresh_user
Browse files Browse the repository at this point in the history
  • Loading branch information
minrk committed Nov 11, 2024
1 parent 886ce6c commit 2965116
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions jupyterhub/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,16 @@ def _deprecated_db(self):
help="""The max age (in seconds) of authentication info
before forcing a refresh of user auth info.
Refreshing auth info allows, e.g. requesting/re-validating auth tokens.
Authenticators that support it may re-load managed groups,
refresh auth tokens, etc., or force a new login if auth info cannot be refreshed.
See :meth:`.refresh_user` for what happens when user auth info is refreshed
(nothing by default).
See :meth:`.refresh_user` for what happens when user auth info is refreshed,
which varies by authenticator.
If an Authenticator does not implement `refresh_user`,
auth info will never be considered stale.
Set `auth_refresh_age = 0` to disable time-based calls to `refresh_user`.
You can still use :attr:`refresh_pre_spawn` if `auth_refresh_age` is disabled.
""",
)

Expand Down

0 comments on commit 2965116

Please sign in to comment.