From 33db75ed46582d9a9d59140d531cea7a5b4a10cc Mon Sep 17 00:00:00 2001 From: Ayaz Salikhov Date: Thu, 27 Jan 2022 20:52:14 +0300 Subject: [PATCH] Do not hardcode values --- docs/using/common.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/using/common.md b/docs/using/common.md index 061fd235..ef8cc206 100644 --- a/docs/using/common.md +++ b/docs/using/common.md @@ -37,12 +37,12 @@ arguments to the `docker run` command. docker run --rm -it -p 8888:8888 -e NB_USER="my-username" -e CHOWN_HOME=yes -w "/home/${NB_USER}" --user root jupyter/base-notebook:latest ``` -- `-e NB_UID=1000` - Instructs the startup script to switch the numeric user ID of `${NB_USER}` to the given value. Default value is `1000`. +- `-e NB_UID=` - Instructs the startup script to switch the numeric user ID of `${NB_USER}` to the given value. Default value is `1000`. This feature is useful when mounting host volumes with specific owner permissions. For this option to take effect, you must run the container with `--user root`. (The startup script will `su ${NB_USER}` after adjusting the user ID.) You might consider using the modern Docker options `--user` and `--group-add` instead. See bullet points regarding `--user` and `--group-add`. -- `-e NB_GID=100` - Instructs the startup script to change the primary group of`${NB_USER}` to `${NB_GID}` +- `-e NB_GID=` - Instructs the startup script to change the primary group of`${NB_USER}` to `${NB_GID}` (the new group is added with a name of `${NB_GROUP}` if it is defined, otherwise the group is named `${NB_USER}`). This feature is useful when mounting host volumes with specific group permissions. For this option to take effect, you must run the container with `--user root`.