https://github.com/jupyterhub/dockerspawner

Spawns JupyterHub single user servers in Docker containers
https://github.com/jupyterhub/dockerspawner

docker-container dockerspawner jupyter jupyterhub spawn-notebook-servers spawner

Last synced: 10 days ago
JSON representation

Spawns JupyterHub single user servers in Docker containers

• Host: GitHub
• URL: https://github.com/jupyterhub/dockerspawner
• Owner: jupyterhub
• License: bsd-3-clause
• Created: 2014-09-26T20:08:26.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2025-03-03T20:41:51.000Z (about 2 months ago)
• Last Synced: 2025-04-06T19:06:22.763Z (17 days ago)
• Topics: docker-container, dockerspawner, jupyter, jupyterhub, spawn-notebook-servers, spawner
• Language: Python
• Homepage: https://jupyterhub-dockerspawner.readthedocs.io
• Size: 727 KB
• Stars: 512
• Watchers: 25
• Forks: 308
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - jupyterhub/dockerspawner - Spawns JupyterHub single user servers in Docker containers (others)
• best-of-jupyter - GitHub - 9% open · ⏱️ 12.02.2025): (JupyterHub Spawners)
• awesome-jupyter-resources - GitHub - 6% open · ⏱️ 05.07.2022): (JupyterHub容器等)

README

        
# DockerSpawner

[![Latest PyPI version](https://img.shields.io/pypi/v/dockerspawner?logo=pypi)](https://pypi.python.org/pypi/dockerspawner)

[![Latest conda-forge version](https://img.shields.io/conda/vn/conda-forge/dockerspawner?logo=conda-forge)](https://anaconda.org/conda-forge/dockerspawner)

[![GitHub Workflow Status - Test](https://img.shields.io/github/actions/workflow/status/jupyterhub/dockerspawner/test.yaml?logo=github&label=tests)](https://github.com/jupyterhub/dockerspawner/actions)

[![Test coverage of code](https://codecov.io/gh/jupyterhub/dockerspawner/branch/main/graph/badge.svg)](https://codecov.io/gh/jupyterhub/dockerspawner)

[![Issue tracking - GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/jupyterhub/dockerspawner/issues)

[![Help forum - Discourse](https://img.shields.io/badge/help_forum-discourse-blue?logo=discourse)](https://discourse.jupyter.org/c/jupyterhub)

The **dockerspawner** (also known as JupyterHub Docker Spawner), enables

[JupyterHub](https://github.com/jupyterhub/jupyterhub) to spawn single user

notebook servers in [Docker containers](https://www.docker.com/resources/what-container).

There are three basic types of spawners available for dockerspawner:

- DockerSpawner: takes an authenticated user and spawns a notebook server

  in a Docker container for the user.

- SwarmSpawner: launches single user notebook servers as Docker Swarm mode

  services.

- SystemUserSpawner: spawns single user notebook servers

  that correspond to system users.

See the [DockerSpawner documentation](https://jupyterhub-dockerspawner.readthedocs.org/en/latest/)

for more information about features and usage.

## Prerequisites

Python 3.9 or above and JupyterHub 4 or above is required.

## Installation

Install dockerspawner to the system:

```bash

pip install dockerspawner

```

## Contributing

If you would like to contribute to the project (:heart:), please read our

[contributor documentation](http://jupyterhub-dockerspawner/en/latest/contributing.html)

and the [`CONTRIBUTING.md`](CONTRIBUTING.md).

## License

We use a shared copyright model that enables all contributors to maintain the

copyright on their contributions.

All code is licensed under the terms of the revised BSD license.

## Getting help

We encourage you to ask questions on the [Discourse community forum](https://discourse.jupyter.org/).

## Resources

### Dockerspawner and JupyterHub

- [Reporting Issues](https://github.com/jupyterhub/dockerspawner/issues)

- JupyterHub tutorial | [Repo](https://github.com/jupyterhub/jupyterhub-tutorial)

  | [Tutorial documentation](http://jupyterhub-tutorial.readthedocs.io/en/latest/)

- [Documentation for JupyterHub](http://jupyterhub.readthedocs.io/en/latest/) | [PDF (latest)](https://media.readthedocs.org/pdf/jupyterhub/latest/jupyterhub.pdf) | [PDF (stable)](https://media.readthedocs.org/pdf/jupyterhub/stable/jupyterhub.pdf)

- [Documentation for JupyterHub's REST API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyterhub/HEAD/docs/rest-api.yml#/default)

### Project Jupyter

- [Documentation for Project Jupyter](http://jupyter.readthedocs.io/en/latest/index.html) | [PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)

- [Project Jupyter website](https://jupyter.org)