Self-host JupyterHub with Levelrail

Multi user server that manages and proxies notebook servers. The install form carries jupyterhub_config.py as an editable file with a generated shared password, so it starts with a working login.

  • Authorjupyterhub
  • LicenceBSD-3-Clause
  • Memory256 MiB
  • Services1

How to self-host JupyterHub

  1. Pull the images

    One image is pulled on your server.

    Show images
    • quay.io/jupyterhub/jupyterhub:5.4.0
  2. Create the app

    One service starts in a single Compose app, with 1 named volume mount for your data, on port 8000.

  3. Fill in the secrets

    You do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

  • Sign in as admin with the generated password shown in the deployment variables, then edit the config file setting to change the authenticator and spawner.

JupyterHub requirements

Memory
About 256 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
8000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
BSD-3-Clause, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then JupyterHub. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the JupyterHub docs page.

Deploy JupyterHub your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy JupyterHub from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain jupyterhub=app.example.com.

levelrail-cli templates install jupyterhub --name my-jupyterhub

Deploy JupyterHub with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/jupyterhub/install \
  -d '{
    "name": "my-jupyterhub"
  }'

JupyterHub configuration

JupyterHub services

ServiceImagePortsVolumes
jupyterhub quay.io/jupyterhub/jupyterhub:5.4.0 8000 data -> /srv/jupyterhub/state

JupyterHub environment variables

The catalog lists no environment variables for this template.

Ports and volumes

Ports
8000
Volumes
1 named mount: data -> /srv/jupyterhub/state

JupyterHub FAQ

How much memory does JupyterHub need?

The catalog lists about 256 MiB of memory for JupyterHub.

Does JupyterHub run on arm64?

For JupyterHub, arm64 support is not confirmed; amd64 is unknown.

What licence is JupyterHub under?

JupyterHub is licensed under BSD-3-Clause, which is permissive, with few conditions on reuse.

Does JupyterHub need configuration before it starts?

No. The template fills in its own defaults.

Which ports does JupyterHub use?

JupyterHub listens on port 8000 inside the stack.

Where does JupyterHub keep its data?

In a named volume: data mounted at /srv/jupyterhub/state.

Can I deploy JupyterHub on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for JupyterHub, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image quay.io/jupyterhub/jupyterhub:5.4.0 is what you deploy there.

levelrail-cli templates install jupyterhub --name my-jupyterhub