JupyterHub

Note

This is the official documentation for JupyterHub. This project is under active development.

JupyterHub is a multi-user server that manages and proxies multiple instances of the single-user Jupyter notebook server.

Three actors:

• multi-user Hub (tornado process)
• configurable http proxy (node-http-proxy)
• multiple single-user IPython notebook servers (Python/IPython/tornado)

Basic principles:

• Hub spawns proxy
• Proxy forwards ~all requests to hub by default
• Hub handles login, and spawns single-user servers on demand
• Hub configures proxy to forward url prefixes to single-user servers

Contents:

User Documentation

• Getting started with JupyterHub
• Further reading
• How JupyterHub works

Configuration

• Writing a custom Authenticator
  • Basics of Authenticators
  • Normalizing and validating usernames
• Writing a custom Spawner
  • Spawner.start
  • Spawner.poll
  • Spawner.stop
  • Spawner state
  • Spawner options form

Developer Documentation

• The JupyterHub API

Community documentation

About JupyterHub

• Summary of changes in JupyterHub
  • 0.3.0
  • 0.2.0
  • 0.1.0

Questions? Suggestions?

• Jupyter mailing list
• Jupyter website
• Stack Overflow - Jupyter
• Stack Overflow - Jupyter-notebook

Indices and tables

• Index
• Module Index
• Search Page