JupyterHub¶
JupyterHub, a multi-user Hub, spawns, manages, and proxies multiple instances of the single-user Jupyter notebook server. JupyterHub can be used to serve notebooks to a class of students, a corporate data science group, or a scientific research group.
Three subsystems make up JupyterHub:
- a multi-user Hub (tornado process)
- a configurable http proxy (node-http-proxy)
- multiple single-user Jupyter notebook servers (Python/IPython/tornado)
JupyterHub performs the following functions:
- The Hub launches a proxy
- The proxy forwards all requests to the Hub by default
- The Hub handles user login and spawns single-user servers on demand
- The Hub configures the proxy to forward URL prefixes to the single-user notebook servers
For convenient administration of the Hub, its users, and services, JupyterHub also provides a REST API.
Contents¶
Installation Guide
Getting Started
- Getting Started
- Configuration Basics
- Networking basics
- Security settings
- Authentication and User Basics
- Spawners and single-user notebook servers
- External services
Technical Reference
- Technical Reference
- Technical Overview
- Security Overview
- Authenticators
- Spawners
- Services
- Using JupyterHub’s REST API
- Upgrading JupyterHub and its database
- Working with templates and UI
- Configuring user environments
- Configuration examples
- Configure GitHub OAuth
- Using a reverse proxy
- Run JupyterHub without root privileges using sudo
API Reference
Tutorials
Troubleshooting
About JupyterHub
Changelog
Indices and tables¶
Questions? Suggestions?¶
Full Table of Contents¶
- Installation Guide
- Getting Started
- Technical Reference
- Technical Overview
- Security Overview
- Authenticators
- Spawners
- Services
- Writing a custom Proxy implementation
- Using JupyterHub’s REST API
- The Hub’s Database
- Upgrading JupyterHub and its database
- Working with templates and UI
- Configuring user environments
- Configuration examples
- Configure GitHub OAuth
- Using a reverse proxy
- Run JupyterHub without root privileges using
sudo
- The JupyterHub API
- Tutorials
- Troubleshooting
- Contributors
- A Gallery of JupyterHub Deployments
- Changelog