mirror of
https://github.com/jupyter/docker-stacks.git
synced 2025-10-18 07:22:57 +00:00
Fix some minor issues in docs
This commit is contained in:
@@ -35,7 +35,7 @@ You do so by passing arguments to the `docker run` command.
|
||||
|
||||
- `-e NB_USER=<username>` - The desired username and associated home folder.
|
||||
The default value is `jovyan`.
|
||||
Setting `NB_USER` refits the `jovyan` default user and ensures that the desired user has the correct file permissions
|
||||
Setting `NB_USER` redefines the `jovyan` default user and ensures that the desired user has the correct file permissions
|
||||
for the new home directory created at `/home/<username>`.
|
||||
For this option to take effect, you **must** run the container with `--user root`, set the working directory `-w "/home/<username>"`
|
||||
and set the environment variable `-e CHOWN_HOME=yes`.
|
||||
@@ -90,7 +90,7 @@ You do so by passing arguments to the `docker run` command.
|
||||
While the default `umask` value should be sufficient for most use cases, you can set the `NB_UMASK` value to fit your requirements.
|
||||
|
||||
```{note}
|
||||
`NB_UMASK` when set only applies to the Jupyter process itself -
|
||||
When `NB_UMASK` is set, it only applies to the Jupyter process itself -
|
||||
you cannot use it to set a `umask` for additional files created during `run-hooks.sh`.
|
||||
For example, via `pip` or `conda`.
|
||||
If you need to set a `umask` for these, you **must** set the `umask` value for each command.
|
||||
@@ -122,7 +122,7 @@ You do so by passing arguments to the `docker run` command.
|
||||
- `-e RESTARTABLE=yes` - Runs Jupyter in a loop so that quitting Jupyter does not cause the container to exit.
|
||||
This may be useful when installing extensions that require restarting Jupyter.
|
||||
- `-v /some/host/folder/for/work:/home/jovyan/work` - Mounts a host machine directory as a folder in the container.
|
||||
This configuration is useful for preserving notebooks and other work even after the container is destroyed.
|
||||
This configuration is useful for preserving notebooks and other work even after the container has been destroyed.
|
||||
**You must grant the within-container notebook user or group (`NB_UID` or `NB_GID`) write access to the host directory (e.g., `sudo chown 1000 /some/host/folder/for/work`).**
|
||||
- `-e JUPYTER_ENV_VARS_TO_UNSET=ADMIN_SECRET_1,ADMIN_SECRET_2` - Unsets specified environment variables in the default startup script.
|
||||
The variables are unset after the hooks have been executed but before the command provided to the startup script runs.
|
||||
@@ -136,7 +136,7 @@ You do so by passing arguments to the `docker run` command.
|
||||
You can further customize the container environment by adding shell scripts (`*.sh`) to be sourced
|
||||
or executables (`chmod +x`) to be run to the paths below:
|
||||
|
||||
- `/usr/local/bin/start-notebook.d/` - handled **before** any of the standard options noted above are applied
|
||||
- `/usr/local/bin/start-notebook.d/` - handled **before** any of the standard options noted above is applied
|
||||
- `/usr/local/bin/before-notebook.d/` - handled **after** all the standard options noted above are applied
|
||||
and ran right before the Server launches
|
||||
|
||||
@@ -246,7 +246,7 @@ This script is handy when you derive a new Dockerfile from this image and instal
|
||||
|
||||
The default Python 3.x [Conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/concepts/environments.html) resides in `/opt/conda`.
|
||||
The `/opt/conda/bin` directory is part of the default `jovyan` user's `${PATH}`.
|
||||
That directory is also searched for binaries when run using `sudo` (`sudo my_binary` will search for `my_binary` in `/opt/conda/bin/`
|
||||
That directory is also searched for binaries when run using `sudo` (`sudo my_binary` will search for `my_binary` in `/opt/conda/bin/`).
|
||||
|
||||
The `jovyan` user has full read/write access to the `/opt/conda` directory.
|
||||
You can use either `mamba`, `pip`, or `conda` (`mamba` is recommended) to install new packages without any additional permissions.
|
||||
|
Reference in New Issue
Block a user