aboutsummaryrefslogtreecommitdiff
path: root/src/jupyterlab/install.sh
blob: 4d426a4a820d8d06efac59f91c9a8eab38df20a0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#!/usr/bin/env bash
#-------------------------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/main/script-library/docs/jupyterlab.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./jupyter-debian.sh

set -ex

VERSION=${1:-"latest"}
USERNAME=${2:-"automatic"}
PYTHON=${3:-"python"}
ALLOW_ALL_ORIGINS=${4:-""}

if [ "$(id -u)" -ne 0 ]; then
    echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
    exit 1
fi

# If in automatic mode, determine if a user already exists, if not use vscode
if [ "${USERNAME}" = "auto" ] || [ "${USERNAME}" = "automatic" ]; then
    USERNAME=""
    POSSIBLE_USERS=("vscode" "node" "codespace" "$(awk -v val=1000 -F ":" '$3==val{print $1}' /etc/passwd)")
    for CURRENT_USER in ${POSSIBLE_USERS[@]}; do
        if id -u ${CURRENT_USER} > /dev/null 2>&1; then
            USERNAME=${CURRENT_USER}
            break
        fi
    done
    if [ "${USERNAME}" = "" ]; then
        USERNAME=vscode
    fi
elif [ "${USERNAME}" = "none" ]; then
    USERNAME=root
    USER_UID=0
    USER_GID=0
fi

addToJupyterConfig() {
  JUPYTER_DIR="/home/${USERNAME}/.jupyter"
  JUPYTER_CONFIG="${JUPYTER_DIR}/jupyter_notebook_config.py"

  # Make sure the config file exists
  test -d ${JUPYTER_DIR} || mkdir ${JUPYTER_DIR}
  test -f ${JUPYTER_CONFIG} || touch ${JUPYTER_CONFIG}

  # Don't write the same line more than once
  grep -q ${1} ${JUPYTER_CONFIG} || echo ${1} >> ${JUPYTER_CONFIG}
}

# Make sure that Python is available
if ! ${PYTHON} --version > /dev/null ; then
  echo "You need to install Python before installing JupyterLab."
  exit 1
fi

# pip skips installation if JupyterLab is already installed
echo "Installing JupyterLab..."
if [ "${VERSION}" = "latest" ]; then
  ${PYTHON} -m pip install jupyterlab --no-cache-dir
else
  ${PYTHON} -m pip install jupyterlab=="${VERSION}" --no-cache-dir
fi

if [ "${ALLOW_ALL_ORIGINS}" = 'true' ]; then
  addToJupyterConfig "c.ServerApp.allow_origin = '*'"
  addToJupyterConfig "c.NotebookApp.allow_origin = '*'"
fi