Self-host JupyterHub on a VPS

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.

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

Specification

Status
Listed
Category
Developer Tools
Services
jupyterhub
Ports
8000
Volumes
1
Memory
about 256 MiB
arm64
unknown
amd64
unknown
Settings to fill in
none
Listing
Community template

About JupyterHub

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.

What it deploys

JupyterHub runs as one service in a single Compose app, listening on port 8000, with 1 named volume mount.

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

Before you install

  • CPU architecture. arm64 unknown. The scan could not read a manifest or the tag is chosen at install time. This is not a claim either way.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.

Settings and environment

The catalog lists no environment variables for this template.

First run

  1. 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.

Install JupyterHub on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get jupyterhub
  4. Install it

    This template has an install form, so the CLI fills each setting from --env, a generated secret or its default.

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

    To put a service behind a domain at install, add --domain SERVICE=HOST:

    levelrail-cli templates install jupyterhub --name my-jupyterhub --domain jupyterhub=jupyterhub.example.com

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then JupyterHub.

More in Developer Tools

All Developer Tools templates