Setup

First of all, you will need to install JupyterHub on your server.

Note that JupyterHub 2.x is not supported. You will need to install a version 1.x (e.g. 1.5).

For a straightforward single-machine setup try The Littlest JupyterHub.

To scale for many users, try the Kubernetes-based Zero to JupyterHub on Kubernetes.

It is also possible to attempt your own direct installation of JupyterHub. See the instructions on JupyterHub’s website.

During JupyterHub configuration, you may need to choose a ‘spawner’ type - the way in which new Jupyter notebook environments are run for new users. Your setup can use the default LocalProcessSpawner, SystemdSpawner, DockerSpawner, or KubeSpawner.

It should be possible to use other spawner types and configurations - please contact us for assistance.

Once JupyterHub is running, please continue based on the spawner or installation type you are using:

Setup:

• LocalProcessSpawner or SystemdSpawner
  • Installing cdsdashboards
  • Installing Presentation Frameworks
  • Changes to jupyterhub_config.py
  • Options
• The Littlest JupyterHub
  • Python environments
  • Installing cdsdashboards
  • Installing Presentation Frameworks
  • Changes to jupyterhub_config.py
  • Options
• DockerSpawner
  • Installing cdsdashboards
  • Generic Changes to jupyterhub_config.py
  • Enabling Dashboards in jupyterhub_config.py
  • Docker Image Requirements
  • Options
• Kubernetes (Z2JH)
  • General Installation
  • Persistent Storage
  • Options
  • Future Development
• Other Spawners
  • BatchSpawners
  • SudoSpawner