From 0d21666f7e24af427c465e33543fc0877dc931be Mon Sep 17 00:00:00 2001 From: Mark Date: Sat, 1 Oct 2022 20:39:47 -0700 Subject: [PATCH] updated README --- jupyter/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/jupyter/README.md b/jupyter/README.md index 584c5be..c4de603 100644 --- a/jupyter/README.md +++ b/jupyter/README.md @@ -13,6 +13,22 @@ The images these files produce contain everything you could possibly want in a j To build this image, run `build/build.fish.` Edit the script to customize the image. +## Configuration + +Change the permissions on the configuration volume (see `docker-compose.yml`) if you get errors. + +You may want to add the following lines to `jupyter_notebook_config.py`: + +``` +c.ServerApp.local_hostnames = ["localhost", "0.0.0.0"] +c.ServerApp.token = "a_long_random_string" +``` + +The first sets `0.0.0.0` to the allowed local hostname list. This prevents a possible "connection reset" when connecting to the docker container. Opens jupyter up to the outside internet, but you should have your inbound ports firewalled off anyway. + +The second line sets a persistent token. If this config value is unset, jupyter will generate a new one on each run, making it hard to make a one-click bookmark. + + ## Image contents - jupyterlab, jupyterhub, notebook