Hub of ElixirNote
With ElixirHub you can create a multi-user Hub that spawns, manages, and proxies multiple instances of the single-user ElixirNote server.
Project ElixirNote created ElixirHub to support many users. The Hub can offer notebook servers to a class of students, a corporate data science workgroup, a scientific research project, or a high-performance computing group.
Three main actors make up ElixirHub:
- multi-user Hub (tornado process)
- configurable http proxy (node-http-proxy)
- multiple single-user ElixirNote servers (Python/Jupyter/tornado)
Basic principles for operation are:
- Hub launches a proxy.
- The 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 the single-user notebook servers.
-
A Linux/Unix based system
-
Python 3.6 or greater
-
-
If you are using
conda, the nodejs and npm dependencies will be installed for you by conda. -
If you are using
pip, install a recent version (at least 12.0) of nodejs/npm.
-
-
If using the default PAM Authenticator, a pluggable authentication module (PAM).
-
TLS certificate and key for HTTPS communication
-
Domain name
ElixirHub can be installed with pip, and the proxy with npm:
git clone [email protected]:ElixirNote/elixirhub.git
npm install -g configurable-http-proxy
pip3 install jhub_cas_authenticator
cd jupyterhub
pip3 install .If any problems, please contact [email protected].
To start the Hub server, run the command:
elixirhub
Visit http://localhost:8000 in your browser, and sign in with your system username and password.
Note: To allow multiple users to sign in to the server, you will need to
run the elixirhub command as a privileged user, such as root.
The Getting Started section of the documentation explains the common steps in setting up ElixirHub.
The ElixirHub tutorial provides an in-depth video and sample configurations of ElixirHub.
To start the Hub on a specific url and port 10.0.1.2:443 with https:
elixirhub --ip 10.0.1.2 --port 443 --ssl-key my_ssl.key --ssl-cert my_ssl.cert
| Authenticator | Description |
|---|---|
| PAMAuthenticator | Built-in authenticator |
| OAuthenticator | OAuth + JupyterHub Authenticator = OAuthenticator |
| ldapauthenticator | Simple LDAP Authenticator Plugin for JupyterHub |
| kerberosauthenticator | Kerberos Authenticator Plugin for JupyterHub |
| Spawner | Description |
|---|---|
| LocalProcessSpawner | Default, built-in spawner starts single-user servers as local processes |
| dockerspawner | Spawn single-user servers in Docker containers |
| kubespawner | Kubernetes spawner for JupyterHub |
| sudospawner | Spawn single-user servers without being root |
| systemdspawner | Spawn single-user notebook servers using systemd |
| batchspawner | Designed for clusters using batch scheduling software |
| yarnspawner | Spawn single-user notebook servers distributed on a Hadoop cluster |
| wrapspawner | WrapSpawner and ProfilesSpawner enabling runtime configuration of spawners |
A starter docker image for ElixirHub gives a baseline deployment of JupyterHub using Docker.
Important: This ElixirNote/elixirhub image contains only the Hub itself,
with no configuration. In general, one needs to make a derivative image, with
at least a elixirhub_config.py setting up an Authenticator and/or a Spawner.
To run the single-user servers, which may be on the same system as the Hub or
not, ElixirNote version 4 or greater must be installed.
The JupyterHub docker image can be started with the following command:
docker run -p 8000:8000 -d --name elixirhub ElixirNote/elixirhub elixirhub
This command will create a container named elixirhub that you can
stop and resume with docker stop/start.
The Hub service will be listening on all interfaces at port 8000, which makes this a good choice for testing ElixirHub on your desktop or laptop.
If you want to run docker on a computer that has a public IP then you should (as in MUST) secure it with ssl by adding ssl options to your docker configuration or by using a ssl enabled proxy.
Mounting volumes will allow you to store data outside the docker image (host system) so it will be persistent, even when you start a new image.
The command docker exec -it elixirhub bash will spawn a root shell in your docker
container. You can use the root shell to create system users in the container.
These accounts will be used for authentication in ElixrHub's default configuration.
If you would like to contribute to the project, please read our
CONTRIBUTING.md. The CONTRIBUTING.md file
explains how to set up a development installation, how to run the test suite,
and how to contribute to documentation.
ElixirHub is supported on Linux/Unix based systems.
ElixirHub officially does not support Windows. You may be able to use ElixirHub on Windows if you use a Spawner and Authenticator that work on Windows, but the ElixirHub defaults will not. Bugs reported on Windows will not be accepted, and the test suite will not run on Windows. Small patches that fix minor Windows compatibility issues (such as basic installation) may be accepted, however. For Windows-based systems, we would recommend running JupyterHub in a docker container or Linux VM.
Additional Reference: Tornado's documentation on Windows platform support
We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.
All code is licensed under the terms of the revised BSD license.
We encourage you to ask questions and share ideas on the Jupyter community forum. You can also talk with us on our JupyterHub Gitter channel.
- Reporting Issues
- JupyterHub tutorial
- Documentation for JupyterHub | PDF (latest) | PDF (stable)
- [Documentation for JupyterHub's REST API][rest api]
- Documentation for Project Jupyter | PDF
- Project Jupyter website
- Project Jupyter community
JupyterHub follows the Jupyter Community Guides.