[doc]: Update README

Signed-off-by: Viet Nguyen Duc <[email protected]>

Author: VietND96

.github/workflows/build-test.yml

@@ -43,6 +43,7 @@ on:
       - '**.md'
       - '**/*.md'
       - 'CHANGELOG/**'
+      - 'tests/build-backward-compatible/**'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref == github.ref_protected && github.run_id || github.event.pull_request.number || github.ref }}

ENV_VARIABLES.md

@@ -23,7 +23,7 @@
 | 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_NODE_GRID_URL | http://localhost:4444 | 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 | 4444 | Hub config, port the Hub should listen on (default 4444) | --port |
@@ -37,10 +37,10 @@
 | SE_UPLOAD_RETAIN_LOCAL_FILE |  |  |  |
 | SE_VIDEO_UPLOAD_BATCH_CHECK |  |  |  |
 | SE_RCLONE_ |  |  |  |
-| SE_OPTS |  |  |  |
+| SE_OPTS |  | This is used to pass any additional CLI options (which doesn't have environment variable representation) to the component. Refer to list supported options per component in [documentation](https://www.selenium.dev/documentation/grid/configuration/cli_options/) |  |
 | SE_EVENT_BUS_HOST |  |  |  |
 | SE_EVENT_BUS_PORT | 5557 |  |  |
-| SE_LOG_LEVEL | INFO |  | --log-level |
+| SE_LOG_LEVEL | INFO | Log level. Default logging level is INFO. Log levels are described [here](https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html) | --log-level |
 | SE_HTTP_LOGS | false |  | --http-logs |
 | SE_STRUCTURED_LOGS | false |  | --structured-logs |
 | SE_EXTERNAL_URL |  |  | --external-url |
@@ -76,7 +76,7 @@
 | SE_EVENT_BUS_SUBSCRIBE_PORT | 4443 |  |  |
 | SE_NODE_SESSION_TIMEOUT | 300 |  | --session-timeout |
 | SE_NODE_ENABLE_MANAGED_DOWNLOADS | true | This causes the Node to auto manage files downloaded for a given session on the Node | --enable-managed-downloads |
-| SE_NODE_ENABLE_CDP |  |  | --enable-cdp |
+| SE_NODE_ENABLE_CDP |  | Enable CDP proxying in Grid. A Grid admin can disable CDP if the network doesnot allow websockets. True by default. | --enable-cdp |
 | SE_NODE_REGISTER_PERIOD | 120 |  | --register-period |
 | SE_NODE_REGISTER_CYCLE | 10 |  | --register-cycle |
 | SE_NODE_HEARTBEAT_PERIOD | 30 |  | --heartbeat-period |

README.md

@@ -76,6 +76,7 @@ Talk to us at https://www.selenium.dev/support/
 * [Building the images](#building-the-images)
 * [Build the images with specific versions](#build-the-images-with-specific-versions)
 * [Upgrade browser version in the images](#upgrade-browser-version-in-the-images)
+* [Upgrade browser and driver versions in the images](#upgrade-browser-and-driver-versions-in-the-images)
 * [Waiting for the Grid to be ready](#waiting-for-the-grid-to-be-ready)
   * [Adding a HEALTHCHECK to the Grid](#adding-a-healthcheck-to-the-grid)
   * [Using a bash script to wait for the Grid](#using-a-bash-script-to-wait-for-the-grid)
@@ -1488,6 +1489,44 @@ You can refer to detail commands in the [Makefile](Makefile) file.
 
 ---
 
+## Upgrade browser and driver versions in the images
+
+| Image name                     | Support |
+|--------------------------------|---------|
+| node-chrome, standalone-chrome | ✅       |
+
+There are two ways of usage this feature.
+
+1. Upgrade Chrome and ChromeDriver later in runtime (when starting the container). Set the container environment `SE_UPDATE_CHROME_COMPONENTS` to `true`. For example:
+    ```bash
+    docker run -d -p 4444:4444 -p 5900:5900 --shm-size="2g" -e SE_UPDATE_CHROME_COMPONENTS=true selenium/standalone-chrome:latest
+    ```
+    Tradeoff:
+    Note that after the container gets restarted, updated binaries will be lost unless you call the update script within the build container process (the second usage below).
+
+2. Build your own image by reusing image layers with upgrading Chrome and ChromeDriver to the latest
+   Create a simple Dockerfile as below
+    ```Dockerfile
+    FROM --platform=linux/amd64 selenium/standalone-chrome:latest
+    RUN /opt/bin/update-chrome-components.sh
+    ```
+    - Option 1: Build your own image tag
+    ```bash
+    docker buildx build --platform linux/amd64 -t selenium/standalone-chrome:my-latest .
+    ```
+   - Option 2: Use Dockerfile in docker compose
+    ```yml
+    services:
+      chrome:
+        build:
+          context: .
+          dockerfile: Dockerfile
+        image: selenium/standalone-chrome:my-latest
+        # Add environments, ports, volumes, etc. as needed
+    ```
+
+---
+
 ## Waiting for the Grid to be ready
 
 It is a good practice to check first if the Grid is up and ready to receive requests, this can be done by checking the `/wd/hub/status` endpoint.

scripts/generate_list_env_vars/description.yaml

@@ -114,7 +114,9 @@
   description: ''
   cli: ''
 - name: SE_OPTS
-  description: ''
+  description: This is used to pass any additional CLI options (which doesn't have
+    environment variable representation) to the component. Refer to list supported
+    options per component in [documentation](https://www.selenium.dev/documentation/grid/configuration/cli_options/)
   cli: ''
 - name: SE_EVENT_BUS_HOST
   description: ''
@@ -123,7 +125,8 @@
   description: ''
   cli: ''
 - name: SE_LOG_LEVEL
-  description: ''
+  description: Log level. Default logging level is INFO. Log levels are described
+    [here](https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html)
   cli: --log-level
 - name: SE_HTTP_LOGS
   description: ''
@@ -232,7 +235,8 @@
     on the Node
   cli: --enable-managed-downloads
 - name: SE_NODE_ENABLE_CDP
-  description: ''
+  description: Enable CDP proxying in Grid. A Grid admin can disable CDP if the network
+    doesnot allow websockets. True by default.
   cli: --enable-cdp
 - name: SE_NODE_REGISTER_PERIOD
   description: ''

scripts/generate_list_env_vars/value.yaml

@@ -101,7 +101,7 @@
 - name: SE_NODE_GRID_GRAPHQL_URL
   default: ''
 - name: SE_NODE_GRID_URL
-  default: ''
+  default: http://localhost:4444
 - name: SE_NODE_HEARTBEAT_PERIOD
   default: '30'
 - name: SE_NODE_HOST