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

Add my overview to intro

Browse Source 
Closes gh-425
This commit is contained in:
Thomas Kluyver
2016-02-13 15:29:08 +00:00
parent e4e43521ee
commit a570e95602
1 changed files with 24 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/source/index.rst
View File

@@ -1,22 +1,33 @@
.. JupyterHub documentation master file, created by
sphinx-quickstart on Mon Jan 4 16:31:09 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
JupyterHub
==========
.. note:: This is the official documentation for JupyterHub. This project is
under active development.
JupyterHub is a server that gives multiple users access to Jupyter notebooks,
running an independent Jupyter notebook server for each user.
JupyterHub is a multi-user server that manages and proxies multiple instances
of the single-user Jupyter notebook server.
To use JupyterHub, you need a Unix server (typically Linux) running
somewhere that is accessible to your team on the network. It might 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>`__). It
runs as an HTTP server. You can get users to go directly to the IP address of
the server in their browser, or provide it with a domain name.
Three actors:
There are different :doc:`authenticators <authenticators>` which 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.
* multi-user Hub (tornado process)
* `configurable http proxy <https://github.com/jupyter/configurable-http-proxy>`_ (node-http-proxy)
* multiple single-user IPython notebook servers (Python/IPython/tornado)
Then there are :doc:`spawners <spawners>`, which control how JupyterHub starts
the notebook servers for individual users. The default spawner will use their
system username to start a notebook server for that user. 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: