Notes about JupyterHub singleuser images in READMEs

README.md

@@ -26,6 +26,8 @@ If this is your first time using Docker or any of the Jupyter projects, do the f
 Starting with [git commit SHA 9bd33dcc8688](https://github.com/jupyter/docker-stacks/tree/9bd33dcc8688):
 
 * Every folder here on GitHub has an equivalent `jupyter/<stack name>` on Docker Hub.
+* Each `*-notebook` stack also has a corresponding `*-singleuser` stack,
+  for use with [JupyterHub](https://jupyterhub.readthedocs.org).
 * The `latest` tag in each Docker Hub repository tracks the `master` branch `HEAD` reference on GitHub.
 * Any 12-character image tag on Docker Hub refers to a git commit SHA here on GitHub. See the [Docker build history wiki page](https://github.com/jupyter/docker-stacks/wiki/Docker-build-history) for a table of build details.
 * Stack contents (e.g., new library versions) will be updated upon request via PRs against this project.

all-spark-notebook/README.md

@@ -14,6 +14,7 @@
 * [tini](https://github.com/krallin/tini) as the container entrypoint and [start-notebook.sh](../minimal-notebook/start-notebook.sh) as the default command
 * Options for HTTPS, password auth, and passwordless `sudo`
 
+
 ## Basic Use
 
 The following command starts a container with the Notebook server listening for HTTP connections on port 8888 without authentication configured.
@@ -238,3 +239,13 @@ source deactivate
 ```
 
 The commands `ipython`, `python`, `pip`, `easy_install`, and `conda` (among others) are available in both environments.
+
+
+## JupyterHub
+
+To use this stack with [JupyterHub](https://jupyterhub.readthedocs.org) and [DockerSpawner](https://github.com/jupyter/dockerspawner),
+set
+
+```python
+c.DockerSpawner.container_image = 'jupyter/all-spark-singleuser'
+```

datascience-notebook/README.md

@@ -56,3 +56,13 @@ source deactivate
 ```
 
 The commands `ipython`, `python`, `pip`, `easy_install`, and `conda` (among others) are available in both environments.
+
+
+## JupyterHub
+
+To use this stack with [JupyterHub](https://jupyterhub.readthedocs.org) and [DockerSpawner](https://github.com/jupyter/dockerspawner),
+set
+
+```python
+c.DockerSpawner.container_image = 'jupyter/datascience-singleuser'
+```

minimal-notebook/README.md

@@ -41,3 +41,13 @@ You may customize the execution of the Docker container and the Notebook server
 ## Conda Environment
 
 The default Python 3.x [Conda environment](http://conda.pydata.org/docs/using/envs.html) resides in `/opt/conda`. The commands `ipython`, `python`, `pip`, `easy_install`, and `conda` (among others) are available in this environment.
+
+
+## JupyterHub
+
+To use this stack with [JupyterHub](https://jupyterhub.readthedocs.org) and [DockerSpawner](https://github.com/jupyter/dockerspawner),
+set
+
+```python
+c.DockerSpawner.container_image = 'jupyter/minimal-singleuser'
+```

pyspark-notebook/README.md

@@ -130,3 +130,13 @@ source deactivate
 ```
 
 The commands `ipython`, `python`, `pip`, `easy_install`, and `conda` (among others) are available in both environments.
+
+
+## JupyterHub
+
+To use this stack with [JupyterHub](https://jupyterhub.readthedocs.org) and [DockerSpawner](https://github.com/jupyter/dockerspawner),
+set
+
+```python
+c.DockerSpawner.container_image = 'jupyter/pyspark-singleuser'
+```

r-notebook/README.md

@@ -37,3 +37,13 @@ You may customize the execution of the Docker container and the Notebook server
 * `-e GRANT_SUDO=yes` - Gives the `jovyan` user passwordless `sudo` capability. Useful for installing OS packages. For this option to take effect, you must run the container with `--user root`. (The `start-notebook.sh` script will `su jovyan` after adding `jovyan` to sudoers.) **You should only enable `sudo` if you trust the user or if the container is running on an isolated host.**
 * `-v /some/host/folder/for/work:/home/jovyan/work` - Host mounts the default working directory on the host to preserve work even when the container is destroyed and recreated (e.g., during an upgrade).
 * `-v /some/host/folder/for/server.pem:/home/jovyan/.local/share/jupyter/notebook.pem` - Mounts a SSL certificate plus key for `USE_HTTPS`. Useful if you have a real certificate for the domain under which you are running the Notebook server.
+
+
+## JupyterHub
+
+To use this stack with [JupyterHub](https://jupyterhub.readthedocs.org) and [DockerSpawner](https://github.com/jupyter/dockerspawner),
+set
+
+```python
+c.DockerSpawner.container_image = 'jupyter/r-singleuser'
+```

scipy-notebook/README.md

@@ -53,3 +53,13 @@ source deactivate
 ```
 
 The commands `ipython`, `python`, `pip`, `easy_install`, and `conda` (among others) are available in both environments.
+
+
+## JupyterHub
+
+To use this stack with [JupyterHub](https://jupyterhub.readthedocs.org) and [DockerSpawner](https://github.com/jupyter/dockerspawner),
+set
+
+```python
+c.DockerSpawner.container_image = 'jupyter/scipy-singleuser'
+```