default.env

# All env in this default.env can be overridden by env.local.

# All env in this default.env must NOT depend on any other env.  If they do, they
# must use single quotes to avoid early expansion before overrides in env.local
# are applied and must be added to the list of DELAYED_EVAL.

export JUPYTERHUB_DOCKER=pavics/jupyterhub
export JUPYTERHUB_VERSION=4.0.2-20230816

# Jupyter single-user server images, can be overriden in env.local to have a space separated list of multiple images
export DOCKER_NOTEBOOK_IMAGES="pavics/workflow-tests:230601"

# Name of the image displayed on the JupyterHub image selection page
# Can be overriden in env.local to have a space separated list of multiple images, the name order must correspond
# to the order of the DOCKER_NOTEBOOK_IMAGES variable
# Note that the selection names are also used as directory names for the tutorial-notebooks directories mounted when
# starting the corresponding image. The name can use the '<name>' or the '<name>:<version>' format. The version will be
# excluded when mounting the corresponding directory.
export JUPYTERHUB_IMAGE_SELECTION_NAMES="pavics"

# Folder on the host to persist Jupyter user data (noteboooks, HOME settings)
export JUPYTERHUB_USER_DATA_DIR='${DATA_PERSIST_ROOT}/jupyterhub_user_data'

# Activates mounting a tutorial-notebooks subfolder that has the same name as the spawned image on JupyterHub
export MOUNT_IMAGE_SPECIFIC_NOTEBOOKS=false

# Path to the file containing the clientID for the google drive extension for jupyterlab
export JUPYTER_GOOGLE_DRIVE_SETTINGS=""

# Jupyter public demo account with limited computing resources for security reasons
export JUPYTER_DEMO_USER="demo"
# Changing any limits requires restarting the jupyter user server
export JUPYTER_DEMO_USER_MEM_LIMIT="2G"  # ex: 2G, 500M
# CPU limit seems not honored by DockerSpawner
export JUPYTER_DEMO_USER_CPU_LIMIT="0.5"  # 50% of 1 CPU

# See config/jupyterhub/custom_templates/login.html.template
export JUPYTER_LOGIN_BANNER_TOP_SECTION=""
export JUPYTER_LOGIN_BANNER_BOTTOM_SECTION=""

# Path to the README.ipynb for welcoming and guiding new users to Jupyterhub.
# If this path is changed, users will have to restart their personal Jupyter
# server for the change to take effect.
export JUPYTERHUB_README=""

# Allow for adding new config or override existing config in
# config/jupyterhub/jupyterhub_config.py.template.
export JUPYTERHUB_CONFIG_OVERRIDE=""

export DELAYED_EVAL="
  $DELAYED_EVAL
  JUPYTERHUB_USER_DATA_DIR
"

# add any new variables not already in 'VARS' or 'OPTIONAL_VARS' that must be replaced in templates here
VARS="
  $VARS
  \$JUPYTERHUB_ADMIN_USERS
"

OPTIONAL_VARS="
  $OPTIONAL_VARS
  \$ENABLE_JUPYTERHUB_MULTI_NOTEBOOKS
  \$JUPYTER_DEMO_USER
  \$JUPYTER_LOGIN_BANNER_TOP_SECTION
  \$JUPYTER_LOGIN_BANNER_BOTTOM_SECTION
  \$JUPYTER_LOGIN_TERMS_URL
  \$JUPYTERHUB_CONFIG_OVERRIDE
  \$JUPYTERHUB_DOCKER
  \$JUPYTERHUB_VERSION
"

# add any component that this component requires to run
COMPONENT_DEPENDENCIES="
  ./config/magpie
"