hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-13 13:02:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3562a0c12102000a0c47fd701af3f832ff9f6c6d
docker-stacks/minimal-notebook
History
Peter Parente 3562a0c121 Configure en_US.UTF-8 
Fixes #82

(c) Copyright IBM Corp. 2015
2015-12-16 22:42:22 -05:00
..
Dockerfile
Configure en_US.UTF-8
2015-12-16 22:42:22 -05:00
jupyter_notebook_config.py
Retain current default port and interface IP
2015-10-20 22:43:12 -04:00
README.md
Remove trivial env vars, doc command line args
2015-10-19 09:36:28 -04:00
start-notebook.sh
Remove need to quote >1 args to start-notebook
2015-10-20 22:43:32 -04:00

README.md

Minimal Jupyter Notebook Stack

What it Gives You

  • Jupyter Notebook 4.0.x
  • Conda Python 3.x
  • No preinstalled scientific computing packages
  • Unprivileged user jovyan (uid=1000, configurable, see options) in group users (gid=100) with ownership over /home/jovyan and /opt/conda
  • tini as the container entrypoint and 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.

docker run -d -p 8888:8888 jupyter/minimal-notebook

Notebook Options

You can pass Jupyter command line options through the start-notebook.sh command when launching the container. For example, to set the base URL of the notebook server you might do the following:

docker run -d -p 8888:8888 jupyter/minimal-notebook start-notebook.sh --NotebookApp.base_url=/some/path

You can use this same approach to sidestep the start-notebook.sh script and run another command entirely. But be aware that this script does the final su to the jovyan user before running the notebook server, after doing what is necessary for the NB_USER and GRANT_SUDO features documented below.

Docker Options

You may customize the execution of the Docker container and the Notebook server it contains with the following optional arguments.

  • -e PASSWORD="YOURPASS" - Configures Jupyter Notebook to require the given password. Should be conbined with USE_HTTPS on untrusted networks.
  • -e USE_HTTPS=yes - Configures Jupyter Notebook to accept encrypted HTTPS connections. If a pem file containing a SSL certificate and key is not provided (see below), the container will generate a self-signed certificate for you.
  • -e NB_UID=1000 - Specify the uid of the jovyan user. Useful to mount host volumes with specific file ownership.
  • -e GRANT_SUDO=yes - Gives the jovyan user passwordless sudo capability. Useful for installing OS packages. 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.

Conda Environment

The default Python 3.x Conda environment resides in /opt/conda. The commands ipython, python, pip, easy_install, and conda (among others) are available in this environment.