Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add the COPY_HOME option in start.sh #1637

Closed
wants to merge 1 commit into from
Closed

add the COPY_HOME option in start.sh #1637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions base-notebook/start.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ if [ "$(id -u)" == 0 ] ; then
# - NB_GID: a group id we want our user to belong to
# - NB_GROUP: the groupname we want for the group
# - GRANT_SUDO: a boolean ("1" or "yes") to grant the user sudo rights
# - COPY_HOME: a boolean ("1" or "yes") to copy the original home files
# - CHOWN_HOME: a boolean ("1" or "yes") to chown the user's home folder
# - CHOWN_EXTRA: a comma separated list of paths to chown
# - CHOWN_HOME_OPTS / CHOWN_EXTRA_OPTS: arguments to the chown commands
Expand Down Expand Up @@ -108,9 +109,9 @@ if [ "$(id -u)" == 0 ] ; then
# directory if it doesn't already exist, and update the current working
# directory to the new location if needed.
if [[ "${NB_USER}" != "jovyan" ]]; then
if [[ ! -e "/home/${NB_USER}" ]]; then
if [[ ! -e "/home/${NB_USER}" || "${COPY_HOME}" == "yes" || "${COPY_HOME}" == "1" ]]; then
_log "Attempting to copy /home/jovyan to /home/${NB_USER}..."
mkdir "/home/${NB_USER}"
mkdir -p "/home/${NB_USER}"
if cp -a /home/jovyan/. "/home/${NB_USER}/"; then
_log "Success!"
else
Expand Down
2 changes: 2 additions & 0 deletions docs/using/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ If you have also **created a new user**, you might be experiencing any of the fo
-e NB_GID=1234 \
-e CHOWN_HOME=yes \
-e CHOWN_HOME_OPTS="-R" \
-e COPY_HOME="yes" \
-w "/home/${NB_USER}" \
-v "${PWD}"/test:/home/callisto/work \
jupyter/minimal-notebook
Expand All @@ -159,6 +160,7 @@ If you have also **created a new user**, you might be experiencing any of the fo

- `-e NB_USER=callisto`: will create a new user `callisto` and automatically add it to the `users` group (does not delete jovyan)
- `-e NB_UID=1234` and `-e NB_GID=1234`: will set the `UID` and `GID` of the new user (`callisto`) to `1234`
- `-e COPY_HOME=yes`: ensure that the new user will have the same files as the old user in its `/home` directory
- `-e CHOWN_HOME_OPTS="-R"` and `-e CHOWN_HOME=yes`: ensure that the new user is the owner of the `/home` directory and subdirectories
(setting `CHOWN_HOME_OPTS="-R` will ensure this change is applied recursively)
- `-w "/home/${NB_USER}"` sets the working directory to be the new user's home
Expand Down