Jupyter

The Jupyter configurations are divided into 2 sections: jupyterhub and jupyter-notebook configurations.

JupyterHub Configurations

The configurations used by the Corridor Platform are the same as the standard Jupyter Hub configurations: https://docs.jupyter.org/en/stable/use/config.html

Some of the commonly used configurations are:

• c.JupyterHub.bind_url: The URL to host JupyterHub on
• c.Authenticator.auth_api_url: The Corridor Web Application Server (When using the Corridor Authentication)
• c.Spawner.env_keep: And environment variables to be kept when spawning the user jupyter-notebooks

The additional configurations provided by the platform are:

c.JupyterHub.authenticator_class

The authenticator class corridor_jupyter.jupyterhub_extension.auth.UserLocalAuthenticator is exposed by Corridor to use for Authentication if the internal Corridor Authentication is being used.

Default: corridor_jupyter.jupyterhub_extension.auth.UserLocalAuthenticator

c.Authenticator.auth_api_url

The API for the Authentication. The URL of the Web Application Server.

Default: http://localhost:5001/api/v1/me

Jupyter Notebook Configurations

The configurations used by the Corridor Platform are the same as the standard Jupyter Server configurations: https://jupyter-server.readthedocs.io/en/latest/users/configuration.html

Some of the commonly used configurations are:

• os.environ['CORRIDOR_API_URL']: The Corridor API Server URL
• os.environ['CORRIDOR_API_KEY']: The Corridor API Key to use (if set)