SeleniumHQ · VietND96 · Jan 8, 2025 · Jan 3, 2025 · Jan 6, 2025 · Jan 6, 2025
diff --git a/Base/Dockerfile b/Base/Dockerfile
@@ -169,31 +169,31 @@ RUN /opt/bin/add-jks-helper.sh -d /opt/selenium/secrets \
 # Configure environement
 #======================================
     # Boolean value, maps "--bind-host"
-ENV SE_BIND_HOST=false \
+ENV SE_BIND_HOST="false" \
     SE_SERVER_PROTOCOL="http" \
     CONFIG_FILE="/opt/selenium/config.toml" \
     # Boolean value, maps "--reject-unsupported-caps"
-    SE_REJECT_UNSUPPORTED_CAPS=false \
-    SE_OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED=true \
+    SE_REJECT_UNSUPPORTED_CAPS="false" \
+    SE_OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED="true" \
     SE_OTEL_TRACES_EXPORTER="otlp" \
     SE_SUPERVISORD_LOG_LEVEL="info" \
     SE_SUPERVISORD_CHILD_LOG_DIR="/tmp" \
     SE_SUPERVISORD_LOG_FILE="/tmp/supervisord.log" \
     SE_SUPERVISORD_PID_FILE="/tmp/supervisord.pid" \
-    SE_SUPERVISORD_AUTO_RESTART=true \
-    SE_SUPERVISORD_START_RETRIES=5 \
+    SE_SUPERVISORD_AUTO_RESTART="true" \
+    SE_SUPERVISORD_START_RETRIES="5" \
     SE_LOG_TIMESTAMP_FORMAT="%Y-%m-%d %H:%M:%S,%3N" \
     SE_LOG_LEVEL="INFO" \
-    SE_HTTP_LOGS=false \
-    SE_STRUCTURED_LOGS=false \
-    SE_ENABLE_TRACING=true \
-    SE_ENABLE_TLS=false \
+    SE_HTTP_LOGS="false" \
+    SE_STRUCTURED_LOGS="false" \
+    SE_ENABLE_TRACING="true" \
+    SE_ENABLE_TLS="false" \
     SE_JAVA_OPTS_DEFAULT="-XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/opt/selenium/logs" \
     SE_JAVA_HEAP_DUMP="false" \
     SE_JAVA_HTTPCLIENT_VERSION="HTTP_1_1" \
     SE_JAVA_SSL_TRUST_STORE="/opt/selenium/secrets/server.jks" \
     SE_JAVA_SSL_TRUST_STORE_PASSWORD="/opt/selenium/secrets/server.pass" \
-    SE_JAVA_DISABLE_HOSTNAME_VERIFICATION=true \
+    SE_JAVA_DISABLE_HOSTNAME_VERIFICATION="true" \
     SE_HTTPS_CERTIFICATE="/opt/selenium/secrets/tls.crt" \
     SE_HTTPS_PRIVATE_KEY="/opt/selenium/secrets/tls.key"
 

diff --git a/Distributor/Dockerfile b/Distributor/Dockerfile
@@ -18,9 +18,9 @@ COPY --chown="${SEL_UID}:${SEL_GID}" start-selenium-grid-distributor.sh \
 COPY selenium-grid-distributor.conf /etc/supervisor/conf.d/
 
 # In seconds, maps to "--session-request-timeout"
-ENV SE_SESSION_REQUEST_TIMEOUT=300 \
+ENV SE_SESSION_REQUEST_TIMEOUT="300" \
 # In seconds, maps to "--session-retry-interval"
-    SE_SESSION_RETRY_INTERVAL=15 \
+    SE_SESSION_RETRY_INTERVAL="15" \
 # In seconds, maps to "--healthcheck-interval"
-    SE_HEALTHCHECK_INTERVAL=120 \
+    SE_HEALTHCHECK_INTERVAL="120" \
     SE_OTEL_SERVICE_NAME="selenium-distributor"
diff --git a/ENV_VARIABLES.md b/ENV_VARIABLES.md
@@ -0,0 +1,121 @@
+| ENV variable | Default value | Description | CLI option represent |
+|--------------|---------------|-------------|----------------------|
+| SE_SCREEN_WIDTH | 1920 | Use in Node to set the screen width |  |
+| SE_SCREEN_HEIGHT | 1080 | Use in Node to set the screen height |  |
+| SE_VIDEO_FILE_NAME | video.mp4 | Use in function video recording to set the output file name. Set `auto` for dynamic file name relying on test metadata |  |
+| SE_FRAME_RATE | 15 | Set the frame rate for FFmpeg in video recording |  |
+| SE_CODEC | libx264 | Set the codec for FFmpeg in video recording |  |
+| SE_PRESET | -preset ultrafast | Set the preset for FFmpeg in video recording |  |
+| SE_VIDEO_UPLOAD_ENABLED | false | Enable video upload |  |
+| SE_VIDEO_INTERNAL_UPLOAD | true | Enable video upload using Rclone in the same recorder container |  |
+| SE_UPLOAD_DESTINATION_PREFIX |  | Remote name and destination path to upload |  |
+| SE_UPLOAD_PIPE_FILE_NAME |  | Set the pipe file name for video upload to consume |  |
+| SE_SERVER_PROTOCOL | http | Protocol for communication between components |  |
+| SE_VIDEO_POLL_INTERVAL | 1 |  |  |
+| SE_VIDEO_WAIT_ATTEMPTS |  |  |  |
+| SE_VIDEO_FILE_READY_WAIT_ATTEMPTS |  |  |  |
+| SE_VIDEO_WAIT_UPLOADER_SHUTDOWN_ATTEMPTS |  |  |  |
+| SE_LOG_TIMESTAMP_FORMAT | %Y-%m-%d %H:%M:%S,%3N |  |  |
+| SE_VIDEO_RECORD_STANDALONE |  |  |  |
+| SE_NODE_PORT |  |  | --port |
+| SE_ROUTER_USERNAME |  | Set the username for basic authentication | --username |
+| SE_ROUTER_PASSWORD |  | Set the password for basic authentication |  |
+| SE_SUPERVISORD_PID_FILE | /tmp/supervisord.pid | Default pid file will be created by supervisord |  |
+| SE_DRAIN_AFTER_SESSION_COUNT | 0 | Drain and detach node from grid after session count exceeds | --drain-after-session-count |
+| SE_SUB_PATH |  | A sub-path that should be considered for all user facing routes on the Hub/Router/Standalone | --sub-path |
+| SE_NODE_GRID_URL |  | Node config, public URL of the Grid as a whole (typically the address of the Hub or the Router) | --grid-url |
+| SE_HUB_HOST |  | Hub config, host address the Hub should listen on | --host |
+| SE_ROUTER_HOST |  | Router config, host address the Router should listen on | --host |
+| SE_HUB_PORT |  | Hub config, port the Hub should listen on (default 4444) | --port |
+| SE_ROUTER_PORT |  | Router config, port the Router should listen on (default 4444) | --port |
+| SE_NODE_GRID_GRAPHQL_URL |  | Video recording config, GraphQL URL to query test metadata for dynamic file name |  |
+| SE_VIDEO_FILE_NAME_TRIM_REGEX | [:alnum:]-_ | Bash regex to trim the file name if it is too long |  |
+| SE_VIDEO_FILE_NAME_SUFFIX |  | Append a suffix session id along with test metadata |  |
+| SE_RCLONE_CONFIG |  |  |  |
+| SE_UPLOAD_COMMAND |  |  |  |
+| SE_UPLOAD_OPTS |  |  |  |
+| SE_UPLOAD_RETAIN_LOCAL_FILE |  |  |  |
+| SE_VIDEO_UPLOAD_BATCH_CHECK |  |  |  |
+| SE_RCLONE_ |  |  |  |
+| SE_OPTS |  |  |  |
+| SE_EVENT_BUS_HOST |  |  |  |
+| SE_EVENT_BUS_PORT |  |  |  |
+| SE_LOG_LEVEL | INFO |  |  |
+| SE_HTTP_LOGS | false |  |  |
+| SE_STRUCTURED_LOGS | false |  |  |
+| SE_EXTERNAL_URL |  |  |  |
+| SE_ENABLE_TLS | false |  |  |
+| SE_JAVA_SSL_TRUST_STORE | /opt/selenium/secrets/server.jks |  |  |
+| SE_JAVA_OPTS |  |  |  |
+| SE_JAVA_SSL_TRUST_STORE_PASSWORD | /opt/selenium/secrets/server.pass |  |  |
+| SE_JAVA_DISABLE_HOSTNAME_VERIFICATION | true |  |  |
+| SE_HTTPS_CERTIFICATE | /opt/selenium/secrets/tls.crt |  |  |
+| SE_HTTPS_PRIVATE_KEY | /opt/selenium/secrets/tls.key |  |  |
+| SE_ENABLE_TRACING | true |  |  |
+| SE_OTEL_EXPORTER_ENDPOINT |  |  |  |
+| SE_OTEL_SERVICE_NAME | selenium-router |  |  |
+| SE_OTEL_JVM_ARGS |  |  |  |
+| SE_OTEL_TRACES_EXPORTER | otlp |  |  |
+| SE_OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED | true |  |  |
+| SE_JAVA_HTTPCLIENT_VERSION | HTTP_1_1 |  |  |
+| SE_JAVA_OPTS_DEFAULT | -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/opt/selenium/logs |  |  |
+| SE_JAVA_HEAP_DUMP | false |  |  |
+| SE_BIND_HOST | false |  |  |
+| SE_SCREEN_DEPTH | 24 |  |  |
+| SE_SCREEN_DPI | 96 |  |  |
+| SE_START_XVFB | true |  |  |
+| SE_START_VNC | true |  |  |
+| SE_START_NO_VNC | true |  |  |
+| SE_VNC_ULIMIT |  |  |  |
+| SE_NO_VNC_PORT | 7900 |  |  |
+| SE_VNC_PORT | 5900 |  |  |
+| SE_VNC_NO_PASSWORD |  |  |  |
+| SE_VNC_VIEW_ONLY |  |  |  |
+| SE_VNC_PASSWORD |  |  |  |
+| SE_EVENT_BUS_PUBLISH_PORT |  |  |  |
+| SE_EVENT_BUS_SUBSCRIBE_PORT |  |  |  |
+| SE_NODE_SESSION_TIMEOUT | 300 |  |  |
+| SE_NODE_ENABLE_MANAGED_DOWNLOADS |  |  |  |
+| SE_NODE_ENABLE_CDP |  |  |  |
+| SE_NODE_REGISTER_PERIOD |  |  |  |
+| SE_NODE_REGISTER_CYCLE |  |  |  |
+| SE_NODE_HEARTBEAT_PERIOD | 30 |  |  |
+| SE_REGISTRATION_SECRET |  |  |  |
+| SE_BROWSER_LEFTOVERS_PROCESSES_SECS | 7200 |  |  |
+| SE_BROWSER_LEFTOVERS_TEMPFILES_DAYS | 1 |  |  |
+| SE_BROWSER_LEFTOVERS_INTERVAL_SECS | 3600 |  |  |
+| SE_DISABLE_UI |  |  |  |
+| SE_REJECT_UNSUPPORTED_CAPS | false |  |  |
+| SE_NEW_SESSION_THREAD_POOL_SIZE |  |  |  |
+| SE_SESSION_REQUEST_TIMEOUT | 300 |  |  |
+| SE_SESSION_RETRY_INTERVAL | 5 |  |  |
+| SE_HEALTHCHECK_INTERVAL | 120 |  |  |
+| SE_RELAX_CHECKS | true |  |  |
+| SE_SESSION_QUEUE_HOST |  |  |  |
+| SE_SESSION_QUEUE_PORT |  |  |  |
+| SE_VIDEO_FOLDER |  |  |  |
+| SE_LOG_LISTEN_GRAPHQL |  |  |  |
+| SE_NODE_PRESTOP_WAIT_STRATEGY |  |  |  |
+| SE_SESSIONS_HOST |  |  |  |
+| SE_SESSIONS_PORT |  |  |  |
+| SE_SESSIONS_MAP_EXTERNAL_DATASTORE | false |  |  |
+| SE_SESSIONS_MAP_HOST |  |  |  |
+| SE_SESSIONS_MAP_PORT |  |  |  |
+| SE_DISTRIBUTOR_HOST |  |  |  |
+| SE_DISTRIBUTOR_PORT |  |  |  |
+| SE_GRID_URL |  |  |  |
+| SE_NODE_DOCKER_CONFIG_FILENAME |  |  |  |
+| SE_NODE_GRACEFUL_SHUTDOWN |  |  |  |
+| SE_VIDEO_CONTAINER_NAME |  |  |  |
+| SE_RECORD_VIDEO | true |  |  |
+| SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP | false |  |  |
+| SE_NODE_MAX_SESSIONS | 1 |  |  |
+| SE_NODE_OVERRIDE_MAX_SESSIONS | false |  |  |
+| SE_OFFLINE | true | Selenium Manager offline mode, use the browser and driver pre-configured in the image |  |
+| SE_NODE_BROWSER_VERSION | stable | Overwrite the default browserVersion in Node stereotype |  |
+| SE_NODE_PLATFORM_NAME | Linux | Overwrite the default platformName in Node stereotype |  |
+| SE_SUPERVISORD_LOG_LEVEL | info |  |  |
+| SE_SUPERVISORD_CHILD_LOG_DIR | /tmp |  |  |
+| SE_SUPERVISORD_LOG_FILE | /tmp/supervisord.log |  |  |
+| SE_SUPERVISORD_AUTO_RESTART | true |  |  |
+| SE_SUPERVISORD_START_RETRIES | 5 |  |  |
diff --git a/Hub/Dockerfile b/Hub/Dockerfile
@@ -15,13 +15,13 @@ EXPOSE 4443
 EXPOSE 4444
 
 # In seconds, maps to "--session-request-timeout"
-ENV SE_SESSION_REQUEST_TIMEOUT=300 \
+ENV SE_SESSION_REQUEST_TIMEOUT="300" \
 # In seconds, maps to "--session-retry-interval"
-    SE_SESSION_RETRY_INTERVAL=15 \
+    SE_SESSION_RETRY_INTERVAL="15" \
 # In seconds, maps to "--healthcheck-interval"
-    SE_HEALTHCHECK_INTERVAL=120 \
+    SE_HEALTHCHECK_INTERVAL="120" \
 # Boolean value, maps "--relax-checks"
-    SE_RELAX_CHECKS=true \
+    SE_RELAX_CHECKS="true" \
     SE_OTEL_SERVICE_NAME="selenium-hub"
 
 COPY --chown="${SEL_UID}:${SEL_GID}" start-selenium-grid-hub.sh \

diff --git a/Makefile b/Makefile
@@ -88,6 +88,10 @@ generate_readme_charts:
 		$$HOME/go/bin/helm-docs --chart-search-root charts/selenium-grid --output-file CONFIGURATION.md --sort-values-order file ; \
 	fi
 
+update_list_env_vars:
+	python3 -m pip install -r tests/requirements.txt ; \
+	python3 scripts/generate_list_env_vars/extract_env.py
+
 lint_readme_charts: generate_readme_charts
 	git diff --stat --exit-code ; \
 	EXIT_CODE=$$? ; \

diff --git a/NodeBase/Dockerfile b/NodeBase/Dockerfile
@@ -31,45 +31,45 @@ ENV LANG_WHICH=${LANG_WHICH} \
 #============================================
 # Shared cleanup script environment variables
 #============================================
-    SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP=false \
-    SE_BROWSER_LEFTOVERS_INTERVAL_SECS=3600 \
-    SE_BROWSER_LEFTOVERS_PROCESSES_SECS=7200 \
-    SE_BROWSER_LEFTOVERS_TEMPFILES_DAYS=1 \
+    SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP="false" \
+    SE_BROWSER_LEFTOVERS_INTERVAL_SECS="3600" \
+    SE_BROWSER_LEFTOVERS_PROCESSES_SECS="7200" \
+    SE_BROWSER_LEFTOVERS_TEMPFILES_DAYS="1" \
 #========================
 # Selenium Configuration
 #========================
     # Drain the Node after N sessions (a value higher than zero enables the feature)
-    SE_DRAIN_AFTER_SESSION_COUNT=0 \
-    SE_NODE_MAX_SESSIONS=1 \
-    SE_NODE_SESSION_TIMEOUT=300 \
-    SE_NODE_OVERRIDE_MAX_SESSIONS=false \
-    SE_NODE_HEARTBEAT_PERIOD=30 \
+    SE_DRAIN_AFTER_SESSION_COUNT="0" \
+    SE_NODE_MAX_SESSIONS="1" \
+    SE_NODE_SESSION_TIMEOUT="300" \
+    SE_NODE_OVERRIDE_MAX_SESSIONS="false" \
+    SE_NODE_HEARTBEAT_PERIOD="30" \
     SE_OTEL_SERVICE_NAME="selenium-node" \
     # Setting Selenium Manager to work offline
-    SE_OFFLINE=true \
+    SE_OFFLINE="true" \
     SE_NODE_BROWSER_VERSION="stable" \
     SE_NODE_PLATFORM_NAME="Linux" \
 #============================
 # Some configuration options
 #============================
     SE_RECORD_VIDEO=false \
     DISPLAY_CONTAINER_NAME="localhost" \
-    SE_SCREEN_WIDTH=1920 \
-    SE_SCREEN_HEIGHT=1080 \
-    SE_SCREEN_DEPTH=24 \
-    SE_SCREEN_DPI=96 \
-    SE_START_XVFB=true \
-    SE_START_VNC=true \
-    SE_START_NO_VNC=true \
-    SE_NO_VNC_PORT=7900 \
-    SE_VNC_PORT=5900 \
-    DISPLAY=:99.0 \
-    DISPLAY_NUM=99 \
+    SE_SCREEN_WIDTH="1920" \
+    SE_SCREEN_HEIGHT="1080" \
+    SE_SCREEN_DEPTH="24" \
+    SE_SCREEN_DPI="96" \
+    SE_START_XVFB="true" \
+    SE_START_VNC="true" \
+    SE_START_NO_VNC="true" \
+    SE_NO_VNC_PORT="7900" \
+    SE_VNC_PORT="5900" \
+    DISPLAY=":99.0" \
+    DISPLAY_NUM="99" \
     # Path to the Configfile
-    CONFIG_FILE=/opt/selenium/config.toml \
-    GENERATE_CONFIG=true \
+    CONFIG_FILE="/opt/selenium/config.toml" \
+    GENERATE_CONFIG="true" \
     # Following line fixes https://github.com/SeleniumHQ/docker-selenium/issues/87
-    DBUS_SESSION_BUS_ADDRESS=/dev/null
+    DBUS_SESSION_BUS_ADDRESS="/dev/null"
 
 RUN apt-get update -qqy \
   && apt-get -qqy --no-install-recommends install \

diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ Talk to us at https://www.selenium.dev/support/
 * [Dev and Beta Channel Browser Images](#dev-and-beta-channel-browser-images)
   * [Dev and Beta Standalone Mode](#dev-and-beta-standalone-mode)
   * [Dev and Beta on the Grid](#dev-and-beta-on-the-grid)
+* [Environment Variables](#environment-variables)
 * [Execution modes](#execution-modes)
   * [Standalone](#standalone)
   * [Hub and Nodes](#hub-and-nodes)
@@ -348,6 +349,24 @@ services:
 
 For more information on the Dev and Beta channel container images, see the blog post on [Dev and Beta Channel Browsers via Docker Selenium](https://www.selenium.dev/blog/2022/dev-and-beta-channel-browsers-via-docker-selenium/).
 
+## Environment Variables
+
+**Checkout full list of environment variables [here](ENV_VARIABLES.md).**
+
+How to update or contribute to list of environment variables? Follow below steps:
+
+1. Refresh the list to pick up new environment variables or default value
+
+    ```bash
+    make update_list_env_vars
+    ```
+
+    The script can be updated in [scripts/generate_list_env_vars/extract_env.py](scripts/generate_list_env_vars/extract_env.py).
+
+2. Update the description for each environment variable in the file [scripts/generate_list_env_vars/description.yaml](scripts/generate_list_env_vars/description.yaml).
+
+3. Run the command in step (1) one more time to update the list of environment variables with new descriptions.
+
 ## Execution modes
 
 ### Standalone

diff --git a/Router/Dockerfile b/Router/Dockerfile
@@ -11,9 +11,9 @@ USER ${SEL_UID}
 #========================
 
 # In seconds, maps to "--session-request-timeout"
-ENV SE_SESSION_REQUEST_TIMEOUT=300 \
+ENV SE_SESSION_REQUEST_TIMEOUT="300" \
 # In seconds, maps to "--session-retry-interval"
-    SE_SESSION_RETRY_INTERVAL=5 \
+    SE_SESSION_RETRY_INTERVAL="5" \
     SE_OTEL_SERVICE_NAME="selenium-router"
 
 EXPOSE 4444

diff --git a/SessionQueue/Dockerfile b/SessionQueue/Dockerfile
@@ -11,9 +11,9 @@ USER ${SEL_UID}
 #========================
 
 # In seconds, maps to "--session-request-timeout"
-ENV SE_SESSION_REQUEST_TIMEOUT=300 \
+ENV SE_SESSION_REQUEST_TIMEOUT="300" \
 # In seconds, maps to "--session-retry-interval"
-    SE_SESSION_RETRY_INTERVAL=15 \
+    SE_SESSION_RETRY_INTERVAL="15" \
     SE_OTEL_SERVICE_NAME="selenium-session-queue"
 
 EXPOSE 5559

diff --git a/Sessions/Dockerfile b/Sessions/Dockerfile
@@ -22,6 +22,6 @@ EXPOSE 5556
 
 ENV SE_OTEL_SERVICE_NAME="selenium-session-map" \
     # Path to the Configfile
-    CONFIG_FILE=/opt/selenium/config.toml \
-    GENERATE_CONFIG=true \
-    SE_SESSIONS_MAP_EXTERNAL_DATASTORE=false
+    CONFIG_FILE="/opt/selenium/config.toml" \
+    GENERATE_CONFIG="true" \
+    SE_SESSIONS_MAP_EXTERNAL_DATASTORE="false"
diff --git a/Standalone/Dockerfile b/Standalone/Dockerfile
@@ -21,14 +21,14 @@ COPY selenium.conf /etc/supervisor/conf.d/
 COPY --chown="${SEL_UID}:${SEL_GID}" generate_config /opt/bin/generate_config
 
 # In seconds, maps to "--session-request-timeout"
-ENV SE_SESSION_REQUEST_TIMEOUT=300 \
+ENV SE_SESSION_REQUEST_TIMEOUT="300" \
 # In seconds, maps to "--session-retry-interval"
-    SE_SESSION_RETRY_INTERVAL=15 \
+    SE_SESSION_RETRY_INTERVAL="15" \
 # In seconds, maps to "--healthcheck-interval"
-    SE_HEALTHCHECK_INTERVAL=120 \
+    SE_HEALTHCHECK_INTERVAL="120" \
 # Boolean value, maps "--relax-checks"
-    SE_RELAX_CHECKS=true \
-    SE_REJECT_UNSUPPORTED_CAPS=true \
+    SE_RELAX_CHECKS="true" \
+    SE_REJECT_UNSUPPORTED_CAPS="true" \
     SE_OTEL_SERVICE_NAME="selenium-standalone"
 
 EXPOSE 4444
diff --git a/StandaloneDocker/Dockerfile b/StandaloneDocker/Dockerfile
@@ -15,9 +15,9 @@ EXPOSE 4444
 COPY --chown="${SEL_UID}:${SEL_GID}" start-selenium-grid-docker.sh /opt/bin/
 
 # In seconds, maps to "--session-request-timeout"
-ENV SE_SESSION_REQUEST_TIMEOUT=300 \
+ENV SE_SESSION_REQUEST_TIMEOUT="300" \
 # In seconds, maps to "--session-retry-interval"
-    SE_SESSION_RETRY_INTERVAL=15 \
+    SE_SESSION_RETRY_INTERVAL="15" \
 # Boolean value, maps "--relax-checks"
-    SE_RELAX_CHECKS=true \
+    SE_RELAX_CHECKS="true" \
     SE_OTEL_SERVICE_NAME="selenium-standalone-docker"