Skip to content

Commit afe6311

Browse files
authored
Fix usage for -w in docs (#1967)
1 parent 4f74f9a commit afe6311

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/using/common.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ You do so by passing arguments to the `docker run` command.
3737
The default value is `jovyan`.
3838
Setting `NB_USER` refits the `jovyan` default user and ensures that the desired user has the correct file permissions
3939
for the new home directory created at `/home/<username>`.
40-
For this option to take effect, you **must** run the container with `--user root`, set the working directory `-w "/home/${NB_USER}"`
40+
For this option to take effect, you **must** run the container with `--user root`, set the working directory `-w "/home/<username>"`
4141
and set the environment variable `-e CHOWN_HOME=yes`.
4242

4343
_Example usage:_
@@ -48,7 +48,7 @@ You do so by passing arguments to the `docker run` command.
4848
--user root \
4949
-e NB_USER="my-username" \
5050
-e CHOWN_HOME=yes \
51-
-w "/home/${NB_USER}" \
51+
-w "/home/my-username" \
5252
jupyter/base-notebook
5353
```
5454

docs/using/troubleshooting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ If you have also **created a new user**, you might be experiencing any of the fo
142142
-e NB_GID=1234 \
143143
-e CHOWN_HOME=yes \
144144
-e CHOWN_HOME_OPTS="-R" \
145-
-w "/home/${NB_USER}" \
145+
-w "/home/callisto" \
146146
-v "${PWD}"/test:/home/callisto/work \
147147
jupyter/minimal-notebook
148148

@@ -162,7 +162,7 @@ If you have also **created a new user**, you might be experiencing any of the fo
162162
- `-e NB_UID=1234` and `-e NB_GID=1234`: will set the `UID` and `GID` of the new user (`callisto`) to `1234`
163163
- `-e CHOWN_HOME_OPTS="-R"` and `-e CHOWN_HOME=yes`: ensure that the new user is the owner of the `/home` directory and subdirectories
164164
(setting `CHOWN_HOME_OPTS="-R` will ensure this change is applied recursively)
165-
- `-w "/home/${NB_USER}"` sets the working directory to be the new user's home
165+
- `-w "/home/callisto"` sets the working directory to be the new user's home
166166

167167
```{admonition} Additional notes
168168
In the example above, the `-v` flag is used to mount the local volume onto the new user's `/home` directory.
@@ -185,7 +185,7 @@ If you have also **created a new user**, you might be experiencing any of the fo
185185
-e NB_GID="$(id -g)" \
186186
-e CHOWN_HOME=yes \
187187
-e CHOWN_HOME_OPTS="-R" \
188-
-w "/home/${NB_USER}" \
188+
-w "/home/callisto" \
189189
-v "${PWD}"/test:/home/callisto/work \
190190
jupyter/minimal-notebook
191191
```

0 commit comments

Comments
 (0)