diff --git a/docs/using/common.md b/docs/using/common.md index 7f35d4e0..e33f78cf 100644 --- a/docs/using/common.md +++ b/docs/using/common.md @@ -30,8 +30,12 @@ arguments to the `docker run` command. default user and ensures that the desired user has the correct file permissions for the new home directory that gets created at `/home/`. For this option to take effect you must run the container with `--user root`, set the working directory `-w /home/${NB_USER}` and set the environment variable `-e CHOWN_HOME=yes`. + Example Usage: - `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` + + ```bash + 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`. This feature is useful when mounting host volumes with specific owner permissions. For this option to take effect, you must run the container