cogstack-jupyter-hub/env/jupyter.env at main · CogStack/cogstack-jupyter-hub · GitHub

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
73
74
75
76
77
78
79
80
81
82
83
84
85
# Spawn containers from this image
# Either use the CoGstack one from the repo which is huge and contains all the stuff needed or,
# use the default official one which is clean.
# possible values:
# newer versions post 1.2.7 have both amd64 and arm64 architecture builds.
#   jupyter-hub ARM64/AMD64: cogstacksystems/jupyter-hub:latest, cogstacksystems/jupyter-hub:latest
#   minimal official image ARM64/AMD64: "jupyterhub/singleuser:latest"
#   jupyter-singleuser ARM64/AMD64: cogstacksystems/jupyter-singleuser:latest, cogstacksystems/jupyter-singleuser:latest
#   jupyter-singleuser-gpu AMD64: ogstacksystems/jupyter-singleuser-gput:latest
#   last stable release build (AMD64 only): "cogstacksystems/jupyter-singleuser:1.2.7"
# The CogStack images are huge and will take a bit to download
JUPYTER_HUB_IMAGE_RELEASE_VERSION=2.2.3
JUPYTER_HUB_SINGLEUSER_DOCKER_NOTEBOOK_IMAGE="cogstacksystems/jupyter-singleuser:${JUPYTER_HUB_IMAGE_RELEASE_VERSION:-latest}"

# This needs to be set to true if you intend to use the GPU image
# possible values: "true", "false"
# if you set this value to "true" you MUST have a gpu on the machine or otherwise IT WILL CRASH
JUPYTERHUB_DOCKER_ENABLE_GPU_SUPPORT="false"

# possible values: "true", "false", use for heavy debugging
JUPYTERHUB_DOCKER_NOTEBOOK_DEBUG_MODE="false"

# give the possibility of selection an image from a list for users
JUPYTERHUB_DOCKER_SELECT_NOTEBOOK_IMAGE_ALLOWED=false

# The timeout in seconds after which the idle notebook container will be shutdown (in seconds) - default: 24 hours
JUPYTERHUB_DOCKER_NOTEBOOK_IDLE_TIMEOUT=86400

# Persist hub data on volume mounted inside container
# "./" all data within the user's folder is saved
# DO NOT CHANGE
JUPYTERHUB_DATA_VOLUME_CONTAINER=""

# These don't really need to be changed.
JUPYTERHUB_SSL_KEY="/srv/jupyterhub/security/nifi.key"
JUPYTERHUB_SSL_CERT="/srv/jupyterhub/security/nifi.pem"

JUPYTER_HUB_DOCKER_NETWORK_NAME="cogstack-net"

# This needs to match the container name of jupyter-hub. In DEV_MODE, change this to : cogstack-jupyter-hub-dev
JUPYTER_HUB_DOCKER_CONTAINER_NAME="cogstack-jupyter-hub"

# general user resource cap per container, default 2 cores, 2GB ram
JUPYTER_HUB_SINGLEUSER_RESOURCE_ALLOCATION_USER_CPU_LIMIT="2"
JUPYTER_HUB_SINGLEUSER_RESOURCE_ALLOCATION_USER_RAM_LIMIT="2.0G"

# admin resource cap per container, default 2 cores, 4 GB RAM
JUPYTER_HUB_SINGLEUSER_RESOURCE_ALLOCATION_ADMIN_CPU_LIMIT="2"
JUPYTER_HUB_SINGLEUSER_RESOURCE_ALLOCATION_ADMIN_RAM_LIMIT="4.0G"

# Set the log level by value or name.
#  Choices: any of [0, 10, 20, 30, 40, 50, "DEBUG", "INFO", "WARN", "ERROR", "CRITICAL"]
#  Default: INFO
JUPYTERHUB_LOG_LEVEL="INFO"

# Shared volume between users (they need to be in the same group)
JUPYTER_HUB_DOCKER_SHARED_DIR="/home/jovyan/scratch"

# The user's own work folder, DO NOT CHANGE THIS
JUPYTER_HUB_DOCKER_NOTEBOOK_DIR="/home/jovyan/work"

# Internal port which the service is started (inside the container)
JUPYTERHUB_INTERNAL_PORT=8888

# Proxy URL
JUPYTERHUB_PROXY_API_URL="http://127.0.0.1:"

# Internal proxy api port
JUPYTERHUB_INTERNAL_PROXY_API_PORT=8887

# SSL port
JUPYTERHUB_SSL_PORT=443

# Auth Setting
JUPYTERHUB_DOCKER_ENABLE_OIDC_AUTH="false"

# OAuth/Keycloak settings - Only used if JUPYTERHUB_DOCKER_ENABLE_OIDC_AUTH is set to true
JUPYTERHUB_OAUTH_CLIENT_ID="cogstack-jupyterhub"
JUPYTERHUB_OAUTH_CLIENT_SECRET="Fkrhu1dxX6aYYEPJ04rDX0stPQNby2dE"
JUPYTERHUB_OAUTH_CALLBACK_URL="https://localhost:8888/hub/oauth_callback"
# Public URL for browser redirects (authorize)
JUPYTERHUB_KEYCLOAK_URL_PUBLIC="http://keycloak.cogstack.localhost"
# Internal URL for backend API calls (token, userdata)
JUPYTERHUB_KEYCLOAK_URL_INTERNAL="http://keycloak:8080"
JUPYTERHUB_KEYCLOAK_REALM="cogstack-realm"