tutor-jupyter 22.0.0

Settings

This plugin has the following Tutor settings. Each setting can be printed with tutor config printvalue JUPYTER_SETTING_NAME and modified with tutor config save --set JUPYTER_SETTING_NAME=value.

Default settings:

• JUPYTER_DOCKER_IMAGE_HUB (default: "{{ DOCKER_REGISTRY }}overhangio/jupyterhub:{{ JUPYTER_VERSION }}")

• JUPYTER_DOCKER_IMAGE_LAB (default: "{{ DOCKER_REGISTRY }}overhangio/jupyterlab:{{ JUPYTER_VERSION }}")

• JUPYTER_HOST (default: "jupyter.{{ LMS_HOST }}")

• JUPYTER_DEFAULT_PASSPORT_ID (default: "jupyterhub")

• JUPYTER_LTI_CLIENT_KEY (default: "openedx")

• JUPYTER_HUB_MYSQL_DATABASE (default: "jupyterhub")

• JUPYTER_HUB_MYSQL_USERNAME (default: "jupyterhub")

• JUPYTER_LAB_CPU_LIMIT (default: None)

• JUPYTER_LAB_MEMORY_LIMIT (default: "200M")

Unique, user-specific settings:

• JUPYTER_HUB_COOKIE_SECRET (default: "{{ 32|jupyterhub_crypt_key }}")

• JUPYTER_HUB_CRYPT_KEY (default: "{{ 32|jupyterhub_crypt_key }}")

• JUPYTER_HUB_MYSQL_PASSWORD (default: "{{ 24|random_string }}")

• JUPYTER_LTI_CLIENT_SECRET (default: "{{ 24|random_string }}")

JupyterHub

The configuration template for the JupyterHub instance is stored in jupyterhub_config.py. This template file includes a {{ patch("jupyterhub-config") }} statement, which means that its contents can be overridden by creating an ad-hoc Tutor plugin. For instance, to add custom LTI keys to your JupyterHub instance:

To modify the “jupyterhub” Docker image and add extra Python packages (for example), you should create a Tutor plugin that implements the “jupyterhub-dockerfile” patch:

Then build the JupyterHub image again:

tutor config save
tutor images build jupyterhub

Lab environment

By default, Jupyter lab notebooks will be spawned that do not include extra Python packages or dependencies. To modify the “jupyterlab” Docker image and add extra Python packages (for example), you should create a Tutor plugin that implements the “jupyterlab-dockerfile” patch:

Then build the lab image again:

tutor config save
tutor images build jupyterlab

You should now be able to run import matplotlib statements within your Jupyter notebooks.