From 598aa287c3c9d583dcfb993c210cbb6c08b199c7 Mon Sep 17 00:00:00 2001 From: Benjamin Saliwanchik Date: Tue, 4 Jun 2024 15:05:24 -0400 Subject: [PATCH] Updating docker run instructions in README and readthedocs. --- docker/README.md | 6 +++--- docs/source/usage.rst | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docker/README.md b/docker/README.md index db49d51..9098bac 100644 --- a/docker/README.md +++ b/docker/README.md @@ -58,17 +58,17 @@ this (or in a similar manner): ```bash -docker run -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -e JUPYTER_TOKEN=docker lusee/lusee-night-unity-luseepy:0.1 +docker run -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -e JUPYTER_TOKEN=docker lusee/lusee-night-unity-luseepy:1.0 ``` -Once the container is running, this command is invoked to bring up Jupyter: +It may be neccessary to run docker in interactive mode, especially when using with Docker Desktop on Windows. In that case, add "-it" immediately after the docker run command. Once the container is running, this command is invoked to bring up Jupyter: ```bash jupyter lab --allow-root --ip 0.0.0.0 --port 8888 ``` The port 8888 can be mapped to any other convenient port on the host machine, -and then access through `localhost`. +and then access through `localhost` by entering: "localhost:8888" into the address bar of your browser. ### Jupyter - approach two diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 4f7a2e6..5b3d591 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -22,15 +22,15 @@ This image also includes Jupyter Lab software. Jupyter is not started automatica .. code-block:: console - $ docker run -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -e JUPYTER_TOKEN=docker lusee/lusee-night-unity-luseepy:0.1 + $ docker run -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -e JUPYTER_TOKEN=docker lusee/lusee-night-unity-luseepy:1.0 -Once the container is running, this command is invoked to bring up Jupyter: +It may be neccessary to run docker in interactive mode, especially when using with Docker Desktop on Windows. In that case, add "-it" immediately after the docker run command. Once the container is running, this command is invoked to bring up Jupyter: .. code-block:: console $ jupyter lab --allow-root --ip 0.0.0.0 --port 8888 -The port 8888 can be mapped to any other convenient port on the host machine, and then access through localhost. +The port 8888 can be mapped to any other convenient port on the host machine, and then access through localhost by entering "localhost:8888" into the address bar of your browser. The Observation --------------