jupyterhub-deploy-docker/examples/custom-notebook-server/README.md
Justin Tyberg 73163c76b9 Initial version.
(c) Copyright IBM Corp. 2016
2016-04-14 15:17:14 -04:00

29 lines
1.1 KiB
Markdown

# Custom Jupyter Notebook Server Image
This is an example of using a custom Jupyter Notebook server Docker image with JupyterHub. The `Dockerfile` builds from the `jupyter/scipy-notebook` image, but customizes the image in the following ways:
* installs an additional Python package to make it available to notebooks
* uses a custom entrypoint script that copies sample notebooks to the user's notebook directory before executing the run command that was provided to the container
## Build the Image
Build and tag the image using the `Dockerfile` in this directory.
```
docker build -t my-custom-notebook .
```
## Run JupyterHub Container
To have JupyterHub spawn the `my-custom-notebook` image for single-user Notebook servers, set the `DOCKER_CONTAINER_IMAGE` environment variable to the image name when you run the JupyterHub container. For example, run the following **from the root directory** of this repository:
```
export DOCKER_CONTAINER_IMAGE=my-custom-notebook
# bring down the JupyterHub container, if running
./hub.sh down
# bring it back up
./hub.sh up -d
```