Skip to content
master
Switch branches/tags
Go to file
Code

README.md

DockerSpawner

GitHub Workflow Status - Test Latest PyPI version Documentation build status GitHub Discourse Gitter

The dockerspawner (also known as JupyterHub Docker Spawner), enables JupyterHub to spawn single user notebook servers in Docker containers.

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 for more information about features and usage.

Prerequisites

JupyterHub 0.7 or above is required, which also means Python 3.3 or above.

Installation

Install dockerspawner to the system:

pip install dockerspawner

Contributing

If you would like to contribute to the project (❤️), please read our contributor documentation and the 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, or Gitter.

Resources

Dockerspawner and JupyterHub

Project Jupyter