mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-08 02:24:08 +00:00
94 lines
2.6 KiB
ReStructuredText
94 lines
2.6 KiB
ReStructuredText
JupyterHub
|
|
==========
|
|
|
|
JupyterHub is a server that gives multiple users access to Jupyter notebooks,
|
|
running an independent Jupyter notebook server for each user.
|
|
|
|
To use JupyterHub, you need a Unix server (typically Linux) running
|
|
somewhere that is accessible to your team on the network. The JupyterHub server
|
|
can be on an internal network at your organisation, or it can run on the public
|
|
internet (in which case, take care with `security <getting-started.html#security>`__).
|
|
Users access JupyterHub in a web browser, by going to the IP address or
|
|
domain name of the server.
|
|
|
|
Different :doc:`authenticators <authenticators>` control access
|
|
to JupyterHub. The default one (pam) uses the user accounts on the server where
|
|
JupyterHub is running. If you use this, you will need to create a user account
|
|
on the system for each user on your team. Using other authenticators, you can
|
|
allow users to sign in with e.g. a Github account, or with any single-sign-on
|
|
system your organisation has.
|
|
|
|
Next, :doc:`spawners <spawners>` control how JupyterHub starts
|
|
the individual notebook server for each user. The default spawner will
|
|
start a notebook server on the same machine running under their system username.
|
|
The other main option is to start each server in a separate container, often
|
|
using Docker.
|
|
|
|
JupyterHub runs as three separate parts:
|
|
|
|
* The multi-user Hub (Python & Tornado)
|
|
* A `configurable http proxy <https://github.com/jupyter/configurable-http-proxy>`_ (NodeJS)
|
|
* Multiple single-user Jupyter notebook servers (Python & 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:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: User Documentation
|
|
|
|
getting-started
|
|
howitworks
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Configuration
|
|
|
|
authenticators
|
|
spawners
|
|
troubleshooting
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Developer Documentation
|
|
|
|
api/index
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Community documentation
|
|
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: About JupyterHub
|
|
|
|
changelog
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Questions? Suggestions?
|
|
|
|
Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>
|
|
Jupyter website <https://jupyter.org>
|
|
Stack Overflow - Jupyter <https://stackoverflow.com/questions/tagged/jupyter>
|
|
Stack Overflow - Jupyter-notebook <https://stackoverflow.com/questions/tagged/jupyter-notebook>
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|