From b68ff7f67fa3e02c638a4d082bc2502cc8ba3112 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Fri, 28 Jan 2022 17:16:26 +0000 Subject: [PATCH] :memo: Minor improvements to docs --- docs/using/common.md | 5 ++--- docs/using/selecting.md | 3 +-- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/using/common.md b/docs/using/common.md index be7bc268..873284c5 100644 --- a/docs/using/common.md +++ b/docs/using/common.md @@ -197,14 +197,13 @@ If you do, keep in mind that features supported by the `start.sh` script and its The default Python 3.x [Conda environment](https://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}`. -TODO: Should whitelist be changes to allowlisted/welcome-listed -That directory is also whitelisted for use in `sudo` commands by the `start.sh` script. +That directory is also allowlisted for use in `sudo` commands by the `start.sh` script. The `jovyan` user has full read/write access to the `/opt/conda` directory. You can use either `pip`, `conda` or `mamba` to install new packages without any additional permissions. ```bash -# install a package into the default (python 3.x) environment and cleanup after +# install a package into the default (python 3.x) environment and cleanup after # the installation mamba install --quiet --yes some-package && \ mamba clean --all -f -y && \ diff --git a/docs/using/selecting.md b/docs/using/selecting.md index 7a70754b..1d5ec441 100644 --- a/docs/using/selecting.md +++ b/docs/using/selecting.md @@ -31,8 +31,7 @@ It is the basis for all other stacks and contains: - [mamba](https://github.com/mamba-org/mamba): "reimplementation of the conda package manager in C++". We use this package manager by default when installing packages. - `notebook`, `jupyterhub` and `jupyterlab` packages - No preinstalled scientific computing packages - -- Unprivileged user `jovyan` (`uid=1000`, configurable, see options) in group `users` (`gid=100`) +- Unprivileged user `jovyan` (`uid=1000`, configurable, [see options in the common features section](./common.md) of this documentation) in group `users` (`gid=100`) with ownership over the `/home/jovyan` and `/opt/conda` paths - `tini` as the container entrypoint and a `start-notebook.sh` script as the default command - A `start-singleuser.sh` script useful for launching containers in JupyterHub