JupyterHub on Windows if you use a Spawner and Authenticator that work on JupyterHub officially does not support Windows. JupyterHub is supported on Linux/Unix based systems.
The CONTRIBUTING.md fileĮxplains how to set up a development installation, how to run the test suite,įor a high-level view of the vision and next directions of the project, see the If you would like to contribute to the project, please read ourĪnd the CONTRIBUTING.md. These accounts will be used for authentication in JupyterHub's default configuration. You can use the root shell to create system users in the container. The command docker exec -it jupyterhub bash will spawn a root shell in your dockerĬontainer. (as in MUST) secure it with ssl by adding ssl options to your dockerĬonfiguration or by using a ssl enabled proxy.Īllow you to store data outside the docker image (host system) so it will be persistent, even when you start If you want to run docker on a computer that has a public IP then you should This a good choice for testing JupyterHub on your desktop or laptop. The Hub service will be listening on all interfaces at port 8000, which makes This command will create a container named jupyterhub that you can The JupyterHub docker image can be started with the following command: docker run -p 8000:8000 -d -name jupyterhub jupyterhub/jupyterhub jupyterhub Not, Jupyter Notebook version 4 or greater must be installed. To run the single-user servers, which may be on the same system as the Hub or In general, one needs to make a derivative image, withĪt least a jupyterhub_config.py setting up an Authenticator and/or a Spawner. Important: This jupyterhub/jupyterhub image contains only the Hub itself, Gives a baseline deployment of JupyterHub using Docker. WrapSpawner and ProfilesSpawner enabling runtime configuration of spawners
Spawn single-user notebook servers distributed on a Hadoop cluster
Spawn single-user notebook servers using systemdĭesigned for clusters using batch scheduling software Spawn single-user servers without being root Spawn single-user servers in Docker containers Kerberos Authenticator Plugin for JupyterHubĭefault, built-in spawner starts single-user servers as local processes Simple LDAP Authenticator Plugin for JupyterHub OAuth + JupyterHub Authenticator = OAuthenticator To start the Hub on a specific url and port 10.0.1.2:443 with https: jupyterhub -ip 10.0.1.2 -port 443 -ssl-key my_ssl.key -ssl-cert my_ssl.cert Authenticators Authenticator To generate a default config file with settings and descriptions: jupyterhub -generate-config Start the Hub Provides an in-depth video and sample configurations of JupyterHub.
Configurationĭocumentation explains the common steps in setting up JupyterHub. Run the jupyterhub command as a privileged user, such as root.ĭescribes how to run the server as a less privileged user, which requires Note: To allow multiple users to sign in to the server, you will need to Visit in your browser, and sign in with your system username and password. To start the Hub server, run the command: jupyterhub
Python3 -m pip install -upgrade notebook Run the Hub server JupyterLab or Jupyter notebook: python3 -m pip install -upgrade jupyterlab If you plan to run notebook servers locally, you will need to install JupyterHub can be installed with pip, and the proxy with npm: npm install -g configurable-http-proxy If you plan to run notebook servers locally, install JupyterLab or Jupyter notebook: conda install jupyterlab To install JupyterHub along with its dependencies including nodejs/npm: conda install -c conda-forge jupyterhub TLS certificate and key for HTTPS communication If using the default PAM Authenticator, a pluggable authentication module (PAM). If you are using pip, install a recent version (at least 12.0) of If you are using conda, the nodejs and npm dependencies will be installed for Hub configures proxy to forward URL prefixes to the single-user notebookįor administration of the Hub and its users.Hub handles login and spawns single-user servers on demand.The Proxy forwards all requests to Hub by default.multiple single-user Jupyter notebook servers (Python/Jupyter/tornado).configurable http proxy (node-http-proxy).The Hub can offer notebook servers to a class of students, a corporateĭata science workgroup, a scientific research project, or a high-performance Project Jupyter created JupyterHub to support many Multi-user Hub that spawns, manages, and proxies multiple instances of the
Our informational page or download our participant information sheet. ĭata collected will include the number of contributors, number of PRs, time taken to close/merge these PRs, and issues closed. Data will be gathered about this repository for approximately the next 12 months, starting from. Please note that this repository is participating in a study into the sustainability of open source projects.