https://github.com/wollac/jupyterhub-docker
Simple deployment of JupyterHub with docker-compose
https://github.com/wollac/jupyterhub-docker
docker docker-compose jupyter jupyterhub
Last synced: 3 months ago
JSON representation
Simple deployment of JupyterHub with docker-compose
- Host: GitHub
- URL: https://github.com/wollac/jupyterhub-docker
- Owner: Wollac
- License: mit
- Created: 2019-09-24T07:43:35.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-03T13:25:59.000Z (almost 6 years ago)
- Last Synced: 2025-07-23T10:56:32.280Z (12 months ago)
- Topics: docker, docker-compose, jupyter, jupyterhub
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jupyterhub-docker
jupyterhub-docker provides a simple deployment of [JupyterHub](https://github.com/jupyter/jupyterhub), a multi-user [Jupyter Notebook](http://jupyter.org/) environment, on a single host using [Docker Compose](https://docs.docker.com/compose/).
## Installation
### Configuration
- Configure Docker Compose: Create the file `.env` in the base folder with the following content:
```
# name of docker network in which the jupyter containers are run
DOCKER_NETWORK=jupyterhub-network
# name of the docker network of traefik
TRAEFIK_NETWORK=traefik
# host under which traefik should make jupyter available
TRAEFIK_HOST=
```
- Configure `userlist`: Create a `userlist` file in the `jupyter-hub` folder.
This file contains the list of authorized JupyterHub users specified by their GitHub usernames, and this file should designate at least one `admin` user.
For example:
```
unrealsoon admin
kittypuree
flangefile
```
- Configure GitHub OAuth: You must pass the GitHub OAuth Client ID, Client Secret and OAuth callback url JupyterHub's runtime.
To do this, add them to an `oauth.env` file in the `secrets` directory of this repository.
You may need to create both the `secrets` directory and the `oauth.env` file.
For example, add the following lines in the `oauth.env` file:
```
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
OAUTH_CALLBACK_URL=https:///hub/oauth_callback
```
### SCIP
The jupyter-notebook requires a local copy of the [SCIP Optimization Suite](http://scip.zib.de).
Follow the installation instructions [here](jupyter-notebook/README.md) to copy the SCIP Optimization Suite files into the `jupyter-nodebook` folder.
### Docker
Run the following command to update the images and start the hub:
```
docker-compose up -d --build
```