• Stars
    star
    7,704
  • Rank 4,694 (Top 0.1 %)
  • Language
    Python
  • License
    Other
  • Created almost 9 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Ready-to-run Docker images containing Jupyter applications

Jupyter Docker Stacks

GitHub actions badge Read the Docs badge pre-commit.ci status Discourse badge Binder badge

Jupyter Docker Stacks are a set of ready-to-run Docker images containing Jupyter applications and interactive computing tools. You can use a stack image to do any of the following (and more):

  • Start a personal Jupyter Server with the JupyterLab frontend (default)
  • Run JupyterLab for a team using JupyterHub
  • Start a personal Jupyter Server with the Jupyter Notebook frontend in a local Docker container
  • Write your own project Dockerfile

Quick Start

You can try a relatively recent build of the quay.io/jupyter/base-notebook image on mybinder.org. Otherwise, the examples below may help you get started if you have Docker installed, know which Docker image you want to use, and want to launch a single Jupyter Application in a container.

The User Guide on ReadTheDocs describes additional uses and features in detail.

Since `2023-10-20` our images are only pushed to `Quay.io` registry.
Older images are available on Docker Hub, but they will no longer be updated.

Example 1

This command pulls the jupyter/scipy-notebook image tagged 2024-03-14 from Quay.io if it is not already present on the local host. It then starts a container running a Jupyter Server with the JupyterLab frontend and exposes the container's internal port 8888 to port 10000 of the host machine:

docker run -p 10000:8888 quay.io/jupyter/scipy-notebook:2024-03-14

You can modify the port on which the container's port is exposed by changing the value of the -p option to -p 8888:8888.

Visiting http://<hostname>:10000/?token=<token> in a browser loads JupyterLab, where:

  • The hostname is the name of the computer running Docker
  • The token is the secret token printed in the console.

The container remains intact for restart after the Server exits.

Example 2

This command pulls the jupyter/datascience-notebook image tagged 2024-03-14 from Quay.io if it is not already present on the local host. It then starts an ephemeral container running a Jupyter Server with the JupyterLab frontend and exposes the server on host port 10000.

docker run -it --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work quay.io/jupyter/datascience-notebook:2024-03-14

The use of the -v flag in the command mounts the current working directory on the host (${PWD} in the example command) as /home/jovyan/work in the container. The server logs appear in the terminal.

Visiting http://<hostname>:10000/?token=<token> in a browser loads JupyterLab.

Due to the usage of the --rm flag Docker automatically cleans up the container and removes the file system when the container exits, but any changes made to the ~/work directory and its files in the container will remain intact on the host. The -i flag keeps the container's STDIN open, and lets you send input to the container through standard input. The -t flag attaches a pseudo-TTY to the container.

By default, [jupyter's root_dir](https://jupyter-server.readthedocs.io/en/latest/other/full-config.html) is `/home/jovyan`.
So, new notebooks will be saved there, unless you change the directory in the file browser.

To change the default directory, you must specify `ServerApp.root_dir` by adding this line to the previous command: `start-notebook.py --ServerApp.root_dir=/home/jovyan/work`.

Choosing Jupyter frontend

JupyterLab is the default for all the Jupyter Docker Stacks images. It is still possible to switch back to Jupyter Notebook (or to launch a different startup command). You can achieve this by passing the environment variable DOCKER_STACKS_JUPYTER_CMD=notebook (or any other valid jupyter subcommand) at container startup; more information is available in the documentation.

Resources

Acknowledgments

CPU Architectures

  • We publish containers for both x86_64 and aarch64 platforms
  • Single-platform images have either aarch64- or x86_64- tag prefixes, for example, quay.io/jupyter/base-notebook:aarch64-python-3.11.6
  • Starting from 2022-09-21, we create multi-platform images (except tensorflow-notebook)
  • Starting from 2023-06-01, we create a multi-platform tensorflow-notebook image as well
  • Starting from 2024-03-14, we create CUDA enabled variant of pytorch-notebook image for x86_64 platform

Using old images

This project only builds one set of images at a time. If you want to use the older Ubuntu and/or Python version, you can use the following images:

Build Date Ubuntu Python Tag
2022-10-09 20.04 3.7 1aac87eb7fa5
2022-10-09 20.04 3.8 a374cab4fcb6
2022-10-09 20.04 3.9 5ae537728c69
2022-10-09 20.04 3.10 f3079808ca8c
2022-10-09 22.04 3.7 b86753318aa1
2022-10-09 22.04 3.8 7285848c0a11
2022-10-09 22.04 3.9 ed2908bbb62e
2023-05-30 22.04 3.10 4d70cf8da953
weekly build 22.04 3.11 latest

Contributing

Please see the Contributor Guide on ReadTheDocs for information about how to contribute recipes, features, tests, and community-maintained stacks.

Alternatives

More Repositories

1

jupyter

Jupyter metapackage for installation, docs and chat
Python
14,721
star
2

notebook

Jupyter Interactive Notebook
Jupyter Notebook
11,046
star
3

nbdime

Tools for diffing and merging of Jupyter notebooks.
TypeScript
2,584
star
4

nbviewer

nbconvert as a web service: Render Jupyter Notebooks as static web pages
Python
2,152
star
5

nbconvert

Jupyter Notebook Conversion
Python
1,648
star
6

nbgrader

A system for assigning and grading notebooks
Python
1,251
star
7

dashboards

[RETIRED] See Voilà as a supported replacement
Jupyter Notebook
981
star
8

colaboratory

[deprecated] Jupyter CoLaboratory, goto google colab now
JavaScript
739
star
9

tmpnb

Creates temporary Jupyter Notebook servers using Docker containers. [DEPRECATED - See BinderHub project]
JavaScript
527
star
10

jupyter-drive

Google drive for jupyter notebooks
TypeScript
417
star
11

qtconsole

Jupyter Qt Console
Python
391
star
12

terminado

Terminals served by tornado websockets
Python
352
star
13

jupyter_client

Jupyter protocol client APIs
Python
350
star
14

atom-notebook

[Deprecated] Jupyter Notebook, but inside Atom.
JavaScript
307
star
15

help

✨ Need some help or have some questions? Please visit our Discourse page.
291
star
16

jupyter_console

Jupyter Terminal Console
Python
240
star
17

nbformat

Reference implementation of the Jupyter Notebook format
Python
240
star
18

jupyter_core

Core Jupyter functionality
Python
191
star
19

docker-notebook

Docker containers for the IPython notebook (+SciPy Stack)
Shell
188
star
20

dashboards_server

[RETIRED] Server that runs and renders Jupyter notebooks as interactive dashboards
JavaScript
181
star
21

jupyter-sphinx

Sphinx extension for rendering of Jupyter interactive widgets.
Python
180
star
22

jupyter.github.io

Project Jupyter's home on the World Wide Web
HTML
175
star
23

nbconvert-examples

Examples that illustrate how nbconvert can be used
Jupyter Notebook
163
star
24

kernel_gateway_demos

Demos associated with the kernel gateway incubator project
Jupyter Notebook
146
star
25

nbclient

A client library for executing notebooks. Formally nbconvert's ExecutePreprocessor
Python
133
star
26

declarativewidgets

[RETIRED] Jupyter Declarative Widget Extension
HTML
120
star
27

enhancement-proposals

Enhancement proposals for the Jupyter Ecosystem
Python
112
star
28

roadmap

Master roadmap for Project Jupyter
84
star
29

papyri

Python
81
star
30

design

Design related materials for Project Jupyter
HTML
80
star
31

governance

The governance process and model for Project Jupyter
Python
80
star
32

dashboards_bundlers

[RETIRED] Converts a notebook to a dashboard and deploys it / downloads it
Python
79
star
33

docker-demo-images

Demo images for use in try.jupyter.org and tmpnb.org
Jupyter Notebook
75
star
34

scipy-advanced-tutorial

Advance Tutorial For SciPy
JavaScript
75
star
35

nb2kg

Python
73
star
36

services

This repository is deprecated. It has been moved to https://github.com/jupyterlab/jupyterlab as a sub-package
TypeScript
70
star
37

accessibility

A repository for ongoing work around making Jupyter's software accessible and inclusive
Python
65
star
38

jupyter-packaging

Tools to help build and install Jupyter Python packages
Python
62
star
39

jupyter_kernel_test

A tool for testing Jupyter kernels
Python
61
star
40

nbclassic

Jupyter Notebook as a Jupyter Server extension
JavaScript
56
star
41

nbmanager

View and stop running IPython notebook servers
Python
50
star
42

ngcm-tutorial

Materials for the IPython/Jupyter workshop at the NGCM Summer Academy, at Southampton University, Boldrewood campus.
Jupyter Notebook
46
star
43

jupyter-js-notebook

JupyterLab notebook
TypeScript
46
star
44

telemetry

Configurable event-logging for Jupyter applications and extensions.
Python
45
star
45

debugger

Research and explorations for an interactive debugger for Jupyter
41
star
46

echo_kernel

A simple example kernel for Jupyter
Python
38
star
47

ipython-py3k

**DO NOT USE THIS REPOSITORY AT ALL** This repo has been merged into the main IPython one that now contains Python 3 support. This is kept only as a reference to developers.
Python
34
star
48

jsplugins

JavaScript Plugins for the IPython Notebook
32
star
49

jupyterhub-2016-workshop

Materials for an online mini-workshop around JupyterHub use cases, held July 22nd, 2016
31
star
50

dashboards_setup

[RETIRED] Recipes for setting up components related to the incubating dashboards effort
Jupyter Notebook
28
star
51

testpath

Test utilities for Python code working with files and commands
Python
26
star
52

strata-sv-2015-tutorial

Strata Silicon Valley 2015 Tutorial
Python
24
star
53

jupyter-js-plugins

TypeScript
23
star
54

jupyter-sphinx-theme

A Sphinx theme for Jupyter and IPython documentation
HTML
22
star
55

jvm-repr

API for converting JVM objects to representations by MIME type, for the Jupyter ecosystem.
Java
22
star
56

surveys

Surveys and datasets collected by Project Jupyter
Jupyter Notebook
21
star
57

tutorial-dashboards-declarativewidgets

Materials for the PyData Carolinas 2016 tutorial, Turning Jupyter Notebooks into Data Applications
Jupyter Notebook
19
star
58

tmpnb-deploy

Deploying tmpnb nodes
Python
18
star
59

notebook-research

Research on the usage of Jupyter notebooks
Jupyter Notebook
18
star
60

security

18
star
61

jupyterlab_json

This repository is deprecated. The extension has moved to https://github.com/jupyterlab/jupyter-renderers
JavaScript
16
star
62

kernels

Kernel testing and listing infrastructure
Python
16
star
63

mozfest15-training

Notebooks for Jupyter training session at Mozfest 2015
Jupyter Notebook
13
star
64

newsletter

A repo for collecting content for the Jupyter Newsletter
Jupyter Notebook
13
star
65

jupyterlab_geojson

This repository is deprecated. The extension has moved to https://github.com/jupyterlab/jupyter-renderers
JavaScript
13
star
66

tmpnb-redirector

Simple HTTP redirector for tmpnb nodes
Python
12
star
67

nature-demo

Materials for the November 2014 Nature Article
Jupyter Notebook
12
star
68

extension-builder

This repository is deprecated.
TypeScript
12
star
69

phosphor-notebook

Phosphor-based jupyter notebook
TypeScript
11
star
70

ipython-components

third-party javascript dependencies of IPython
JavaScript
11
star
71

jupyter-js-output-area

DEPRECATED: Javascript APIs for Jupyter output areas
TypeScript
10
star
72

cookiecutter-docker-stacks

Cookiecutter for community-maintained Jupyter Docker images
Python
10
star
73

ideas

A place for the Jupyter community to connect on ideas
9
star
74

try.jupyter.org

Try Jupyter!
HTML
9
star
75

jupyter_events

Configurable event system for Jupyter applications and extensions.
Python
9
star
76

jupyter-js-ui

TypeScript
9
star
77

kernel_gateway_bundlers

Converts a notebook to a kernel gateway microservice bundle for download
Python
8
star
78

jupyter_markdown

Documentation and tests related to Jupyter's Markdown syntax
Jupyter Notebook
8
star
79

try-jupyter

A JupyterLite deployment to try JupyterLab, Jupyter Notebook and IPython in the browser
Jupyter Notebook
8
star
80

talks

A collection of talks about Jupyter and IPython projects
Jupyter Notebook
8
star
81

jvm-magics

A plugin system for magic function implementations across JVM kernels.
Java
7
star
82

jupyter-js-utils

JavaScript utilities for the Jupyter frontend
TypeScript
6
star
83

cdn.jupyter.org

Assets and layout for cdn.jupyter.org
Python
6
star
84

jupyter_logger

Allows you to log Jupyter notebook user events anonymously.
TypeScript
6
star
85

jupyter-js-filebrowser

DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-ui
TypeScript
5
star
86

jupyter-sprints

Resources for running a sprint
HTML
5
star
87

docs-team-compass

Documentation Work Group Discussions
HTML
5
star
88

nbcache

Notebook Caching layer in Docker
5
star
89

sphinxcontrib_github_alt

Github roles for Sphinx docs
Python
5
star
90

jupyter-js-input-area

DEPRECATED: Javascript APIs for Jupyter input areas
TypeScript
5
star
91

jupyterhub-carina

[RETIRED] JupyterHub integration with Carina
Python
5
star
92

win-tornado-terminals

Windows terminal backend for tornado
Python
5
star
93

jupyterlab-fasta

DEPRECATED: Moved to https://github.com/jupyterlab/jupyter-renderers. A JupyterLab Fasta viewer
TypeScript
5
star
94

spreadsheet

A spreadsheet component for phosphor
JavaScript
5
star
95

notebook_shim

A shim layer for notebook traits and config
Python
4
star
96

jupyter-js-editor

DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-notebook
TypeScript
4
star
97

jupyter-communitycalls

📣 Resources for planning and hosting the Jupyter Community Calls
4
star
98

project-mgt

4
star
99

tutorial-devteam-jupyterhub-2017

Resources for the dev team tutorial on JupyterHub 2017-01-27
4
star
100

showcase

[RETIRED] A spot to try demos of one or more incubating Jupyter projects in Binder
Makefile
4
star