Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 4 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: 2024-12-02T07:56:55.000Z (3 months ago)
- Last Synced: 2025-02-07T12:07:28.824Z (11 days ago)
- Topics: docker-container, dockerspawner, jupyter, jupyterhub, spawn-notebook-servers, spawner
- Language: Python
- Homepage: https://jupyterhub-dockerspawner.readthedocs.io
- Size: 665 KB
- Stars: 505
- Watchers: 27
- Forks: 309
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 6% open · ⏱️ 05.07.2022): (JupyterHub容器等)
- awesome-starred - jupyterhub/dockerspawner - Spawns JupyterHub single user servers in Docker containers (others)
- best-of-jupyter - GitHub - 9% open · ⏱️ 02.12.2024): (JupyterHub Spawners)
README
# DockerSpawner
[](https://pypi.python.org/pypi/dockerspawner)
[](https://anaconda.org/conda-forge/dockerspawner)
[](https://github.com/jupyterhub/dockerspawner/actions)
[](https://codecov.io/gh/jupyterhub/dockerspawner)
[](https://github.com/jupyterhub/dockerspawner/issues)
[](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)