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

Reword intro

Browse Source
This commit is contained in:
Thomas Kluyver
2016-02-13 16:44:41 +00:00
parent a570e95602
commit d40dcc35fb
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/index.rst
View File

@@ -5,23 +5,24 @@ JupyterHub is a server that gives multiple users access to Jupyter notebooks,
running an independent Jupyter notebook server for each user. running an independent Jupyter notebook server for each user.
To use JupyterHub, you need a Unix server (typically Linux) running 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 somewhere that is accessible to your team on the network. The JupyterHub server
internal network at your organisation, or it can run on the public internet (in can be on an internal network at your organisation, or it can run on the public
which case, take care with `security <getting-started.html#security>`__). It internet (in which case, take care with `security <getting-started.html#security>`__).
runs as an HTTP server. You can get users to go directly to the IP address of Users access JupyterHub in a web browser, by going to the IP address or
the server in their browser, or provide it with a domain name. domain name of the server.
There are different :doc:`authenticators <authenticators>` which control access Different :doc:`authenticators <authenticators>` control access
to JupyterHub. The default one (pam) uses the user accounts on the server where 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 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 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 allow users to sign in with e.g. a Github account, or with any single-sign-on
system your organisation has. system your organisation has.
Then there are :doc:`spawners <spawners>`, which control how JupyterHub starts Next, :doc:`spawners <spawners>` control how JupyterHub starts
the notebook servers for individual users. The default spawner will use their the individual notebook server for each users. The default spawner will use
system username to start a notebook server for that user. The other main option start a notebook server on the same machine running under their system username.
is to start each server in a separate container, often using Docker. The other main option is to start each server in a separate container, often
using Docker.
JupyterHub runs as three separate parts: JupyterHub runs as three separate parts: