hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 23:42:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4074 from ToobaJamal/edit

Browse Source 
Update index.rst
This commit is contained in:
Min RK
2022-10-17 13:05:14 +02:00
committed by GitHub
parent 93529d11bc 99255b04ac
commit d2d9ce9d02
1 changed files with 17 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/source/index.rst
View File

@@ -2,31 +2,29 @@
JupyterHub JupyterHub
========== ==========
`JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users. `JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users.
It can be used in a class of students, a corporate data science group or scientific 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 research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple
instances of the single-user `Jupyter notebook`_ server. instances of the single-user `Jupyter notebook`_ server.
To make life easier, JupyterHub has distributions. Be sure to JupyterHub offers distributions for different use cases. Be sure to
take a look at them before continuing with the configuration of the broad take a look at them before continuing with the configuration of the broad
original system of `JupyterHub`_. Today, you can find two main cases: original system of `JupyterHub`_. As of now, you can find two main cases:
1. If you need a simple case for a small amount of users (0-100) and single server 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.
take a look at 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.
`The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution.
2. If you need to allow for even more users, a dynamic amount of servers can be used on a cloud,
take a look at the `Zero to JupyterHub with Kubernetes <https://github.com/jupyterhub/zero-to-jupyterhub-k8s>`__ .
Four subsystems make up JupyterHub: Four subsystems make up JupyterHub:
* a **Hub** (tornado process) that is the heart of 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 * 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 * 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 * 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 kernels on an admin panel. A simplification of the whole system can be seen in the figure below: 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 .. image:: images/jhub-fluxogram.jpeg
:alt: JupyterHub subsystems :alt: JupyterHub subsystems
@@ -56,17 +54,17 @@ Contents
Distributions Distributions
------------- -------------
A JupyterHub **distribution** is tailored towards a particular set of Each JupyterHub **distribution** is tailored toward a particular set of
use cases. These are generally easier to set up than setting up use cases. These are generally easier to set up than setting up
JupyterHub from scratch, assuming they fit your use case. JupyterHub from scratch, assuming they fit your use case.
The two popular ones are: The two popular ones are:
* `Zero to JupyterHub on Kubernetes <http://z2jh.jupyter.org>`_, for
running JupyterHub on top of `Kubernetes <https://k8s.io>`_. This
can scale to large number of machines & users.
* `The Littlest JupyterHub <http://tljh.jupyter.org>`_, for an easy * `The Littlest JupyterHub <http://tljh.jupyter.org>`_, for an easy
to set up & run JupyterHub supporting 1-100 users on a single machine. 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 Installation Guide
------------------ ------------------
@@ -119,8 +117,8 @@ RBAC Reference
Contributing Contributing
------------ ------------
We want you to contribute to JupyterHub in ways that are most exciting We welcome you to contribute to JupyterHub in ways that are most exciting
& useful to you. We value documentation, testing, bug reporting & code equally, & useful to you. We value documentation, testing, bug reporting & code equally
and are glad to have your contributions in whatever form you wish :) 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>`_ Our `Code of Conduct <https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md>`_