mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-08 02:24:08 +00:00
156 lines
4.4 KiB
ReStructuredText
156 lines
4.4 KiB
ReStructuredText
==========
|
|
JupyterHub
|
|
==========
|
|
|
|
`JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users.
|
|
Because JupyterHub manages a separate Jupyter environment for each user,
|
|
it can be used in a class of students, a corporate data science group, or a scientific
|
|
research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple
|
|
instances of the single-user `Jupyter notebook`_ server.
|
|
|
|
JupyterHub offers distributions for different use cases. Be sure to
|
|
take a look at them before continuing with the configuration of the broad
|
|
original system of `JupyterHub`_. As of now, you can find two main cases:
|
|
|
|
1. `The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution is suitable if you need a small number of users (1-100) and a single server with a simple environment.
|
|
2. `Zero to JupyterHub with Kubernetes <https://github.com/jupyterhub/zero-to-jupyterhub-k8s>`__ allows you to deploy dynamic servers on the cloud if you need even more users.
|
|
|
|
|
|
Four subsystems make up JupyterHub:
|
|
|
|
* a **Hub** (tornado process) that is the heart of JupyterHub
|
|
* a **Configurable HTTP Proxy** (node-http-proxy) that receives the requests from the client's browser
|
|
* multiple **Single-User Jupyter Notebook Servers** (Python/IPython/tornado) that are monitored by Spawners
|
|
* an **Authentication Class** that manages how users can access the system
|
|
|
|
|
|
Besides these central pieces, you can add optional configurations through a `config.py` file and manage users' environments through an admin panel. A simplification of the whole system can be seen in the figure below:
|
|
|
|
.. image:: images/jhub-fluxogram.jpeg
|
|
:alt: JupyterHub subsystems
|
|
:width: 80%
|
|
:align: center
|
|
|
|
|
|
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 :doc:`REST API <reference/rest-api>`.
|
|
|
|
The JupyterHub team and Project Jupyter value our community, and JupyterHub
|
|
follows the Jupyter `Community Guides <https://jupyter.readthedocs.io/en/latest/community/content-community.html>`_.
|
|
|
|
Contents
|
|
========
|
|
|
|
.. _index/distributions:
|
|
|
|
Distributions
|
|
-------------
|
|
|
|
Each JupyterHub **distribution** is tailored toward a particular set of
|
|
use cases. These are generally easier to set up than setting up
|
|
JupyterHub from scratch, assuming they fit your use case.
|
|
|
|
The two popular ones are:
|
|
|
|
* `The Littlest JupyterHub <http://tljh.jupyter.org>`_, for an easy
|
|
to set up & run JupyterHub supporting 1-100 users on a single machine.
|
|
* `Zero to JupyterHub on Kubernetes <http://z2jh.jupyter.org>`_, for
|
|
running JupyterHub on top of `Kubernetes <https://k8s.io>`_. This
|
|
can scale to a large number of machines & users.
|
|
|
|
Installation Guide
|
|
------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
installation-guide
|
|
|
|
Getting Started
|
|
---------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
getting-started/index
|
|
|
|
Technical Reference
|
|
-------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
reference/index
|
|
|
|
Administrators guide
|
|
--------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
index-admin
|
|
|
|
API Reference
|
|
-------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api/index
|
|
|
|
RBAC Reference
|
|
--------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
rbac/index
|
|
|
|
Contributing
|
|
------------
|
|
|
|
We welcome you to contribute to JupyterHub in ways that are most exciting
|
|
& useful to you. We value documentation, testing, bug reporting & code equally
|
|
and are glad to have your contributions in whatever form you wish :)
|
|
|
|
Our `Code of Conduct <https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md>`_
|
|
(`reporting guidelines <https://github.com/jupyter/governance/blob/HEAD/conduct/reporting_online.md>`_)
|
|
helps keep our community welcoming to as many people as possible.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
contributing/index
|
|
|
|
About JupyterHub
|
|
----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
index-about
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
|
|
|
|
Questions? Suggestions?
|
|
=======================
|
|
|
|
- `Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>`_
|
|
- `Jupyter website <https://jupyter.org>`_
|
|
|
|
.. _JupyterHub: https://github.com/jupyterhub/jupyterhub
|
|
.. _Jupyter notebook: https://jupyter-notebook.readthedocs.io/en/latest/
|