mm/jupyterhub-deploy-docker
1
0
Fork 0
Code Pull Requests Releases Activity

Merge pull request #2 from jtyberg/custom-image-faq

Browse Source 
Update README: add FAQs
This commit is contained in:
Carol Willing 2016-04-18 07:55:59 -07:00
commit a7f38aaf2f
1 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -177,7 +177,7 @@ Note that the Docker stacks `*-notebook` images tagged `2d878db5cbff` include th
docker pull jupyter/scipy-notebook:2d878db5cbff
```
Note: If you choose to use a different container image, be sure to set the `DOCKER_CONTAINER_IMAGE` environment variable either in the shell you use to launch JupyterHub or in the `.env` file.
Note: If you choose to use a different container image, you must set the `DOCKER_CONTAINER_IMAGE` environment variable in the `.env` file, or override it in the environment where you launch JupyterHub.
## Run the JupyterHub container
@ -211,6 +211,34 @@ Use `docker logs <container>`. For example, to view the logs of the `jupyterhub
docker logs jupyterhub
```
### How do I specify the Notebook server image to spawn for users?
In this deployment, JupyterHub uses DockerSpawner to spawn single-user Notebook servers. The `jupyterhub_config.py` reads the image name from the `DOCKER_CONTAINER_IMAGE` environment variable.
```
c.DockerSpawner.container_image = os.environ['DOCKER_CONTAINER_IMAGE']
```
By default, this variable is set in the `.env` file.
```
DOCKER_CONTAINER_IMAGE=jupyter/scipy-notebook:2d878db5cbff
```
You can either change this value in the `.env` file, or you can override it by setting the `DOCKER_CONTAINER_IMAGE` variable to a different Notebook image in the environment where you launch JupyterHub.
```
DOCKER_CONTAINER_IMAGE=jupyterhub/pyspark-notebook:2d878db5cbff \
./hub.sh up -d
```
### If I change the name of the Notebook server image to spawn, do I need to restart JupyterHub?
Yes. JupyterHub reads its configuration and sets the name of the Notebook server image to spawn during startup. It you change the name of the Docker image to spawn, then you will need to restart the JupyterHub container.
In this deployment, cookies are persisted to a Docker volume on the host, so restarting JupyterHub might cause a blip in service as the JupyterHub container restarts, but users will not have to login again; however, users may need to refresh their browsers to re-establish connections to active Notebook kernels.
### How can I backup a user's notebook directory?
There are multiple ways to [backup and restore](https://docs.docker.com/engine/userguide/containers/dockervolumes/#backup-restore-or-migrate-data-volumes) data in Docker containers.