mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-15 14:03:02 +00:00
Add initial index file
This commit is contained in:
@@ -3,14 +3,71 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Welcome to JupyterHub's documentation!
|
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:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
:caption: User Documentation
|
||||||
|
|
||||||
|
getting-started
|
||||||
|
how-it-works
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: Configuration
|
||||||
|
|
||||||
|
authenticators
|
||||||
|
spawners
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:caption: Developer Documentation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.. 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
|
Indices and tables
|
||||||
|
Reference in New Issue
Block a user