JupyterHub Documentation

JupyterHub Documentation

Release 1.0.0.dev

Project Jupyter team

Sep 11, 2018

Contents

1

Contents

3

2

Indices and tables

5

3

Questions? Suggestions?

7

4

Full Table of Contents

4.1 Installation Guide . . . . . . . . . . .

4.2 Getting Started . . . . . . . . . . . . .

4.3 Technical Reference . . . . . . . . . .

4.4 The JupyterHub API . . . . . . . . . .

4.5 Tutorials . . . . . . . . . . . . . . . .

4.6 Troubleshooting . . . . . . . . . . . .

4.7 Contributors . . . . . . . . . . . . . .

4.8 A Gallery of JupyterHub Deployments

4.9 Changelog . . . . . . . . . . . . . . .

Python Module Index

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

9

.

9

. 12

. 21

. 60

. 91

. 93

. 99

. 102

. 106

115

i

ii

JupyterHub Documentation, Release 1.0.0.dev

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

1

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download