hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-09 02:54:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

adding to NB_USER environment variable option description

Browse Source
This commit is contained in:
rigzba21
2022-01-27 06:53:30 -05:00
parent ec8addb64b
commit c3382f76da
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/using/common.md
View File

@@ -26,11 +26,9 @@ Several configurable environment variables exist that allow for customizing the
launching the notebook server. These environment variables are configured by passing arguments to the launching the notebook server. These environment variables are configured by passing arguments to the
`docker run` command. `docker run` command.
- `-e NB_USER=<username>` - Instructs the startup script to change the default container username from `jovyan` to the provided value. - `-e NB_USER=<username>` - The desired username and associated home folder. Default value is `jovyan`. Setting `NB_USER` refits the `jovyan`
Causes the script to rename the `jovyan` user home folder. default user and ensures that the desired user has the correct file permissions for the new home directory that gets created at
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` (see below for detail). `/home/<username>`. Use this environment variable argument when mounting host volumes with a specific home folder.
This feature is useful when mounting host volumes with specific home folder.
Example usage:
- `-e NB_UID=1000` - Instructs the startup script to switch the numeric user ID of `${NB_USER}` to the given value. - `-e NB_UID=1000` - Instructs the startup script to switch the numeric user ID of `${NB_USER}` to the given value.
This feature is useful when mounting host volumes with specific owner permissions. 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`. For this option to take effect, you must run the container with `--user root`.