Self-host Jupyter Notebook (jupyter-notebook) on a VPS

A Jupyter Notebook server for interactive Python data work, protected by a generated access token.

levelrail-cli templates deploy jupyter-notebook --name my-jupyter-notebook

Specification

Status
Listed
Category
Developer Tools
Services
jupyter
Ports
8888
Volumes
1
Memory
about 512 MiB
arm64
image published
amd64
image published
Settings to fill in
none
License
not yet recorded

About Jupyter Notebook

A Jupyter Notebook server for interactive Python data work, protected by a generated access token. Runs as a single container from the base-notebook image, listening on port 8888; data is kept in named volumes.

What it deploys

Jupyter Notebook runs as one service in a single Compose app, listening on port 8888, with 1 named volume mount.

ServiceImageTagPortsVolumes
jupyter quay.io/jupyter/base-notebook latest 8888 jupyter_work -> /home/jovyan/work

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 8888 directly on the host, so open them in the VPS firewall only if you want that.
  • Review. Image is not pinned to a version tag, so a redeploy can pull different code (quay.io/jupyter/base-notebook:latest).

Settings and environment

You do not have to fill in anything. 1 secret is generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
jupyterJUPYTER_TOKENGenerated at deploy

Install Jupyter Notebook 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 jupyter-notebook
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy jupyter-notebook --name my-jupyter-notebook

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

More in Developer Tools

All Developer Tools templates