zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Explain culler settings better

Browse Source
This commit is contained in:
1kastner
2020-08-25 16:47:34 +02:00
committed by GitHub
parent 5e90b27ff7
commit ef2fed4bc9
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/topic/idle-culler.rst
View File

@@ -8,15 +8,15 @@ The idle culler automatically shuts down user notebook servers when they have
not been used for a certain time period, in order to reduce the total resource
usage on your JupyterHub.
JupyterHub pings the user's notebook server at certain time intervals. If no response
is received from the server during this checks and the timeout expires, the server is
considered to be *inactive (idle)* and will be culled.
The idle culler is maintained as
`a separate project <https://github.com/jupyterhub/jupyterhub-idle-culler>`_.
For advanced users, the code leaves the option for direct adjustment, e.g. to add
features such as purging old user data.
The idle culler is a JupyterHub service that is installed and enabled by default in TLJH.
It can be configured using tljh-config. For advanced use-cases, like purging old user data,
the idle culler configuration can be extended beyond tljh-config options, using custom
`jupyterhub_config.py snippets <https://tljh.jupyter.org/en/latest/topic/escape-hatch.html?highlight=escape-hatch#extending-jupyterhub-config-py>`__.
Default settings
================