Skip to content

Commit 8475efc

Browse files
VietND96VietND96
committed
[docs] Generate list environment variables
Signed-off-by: Viet Nguyen Duc <[email protected]>
1 parent 4024ce8 commit 8475efc

File tree

8 files changed

+844
-2
lines changed

8 files changed

+844
-2
lines changed

‎ENV_VARIABLES.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
| ENV variable | Default value | Description | CLI option represent |
2+
|--------------|---------------|-------------|----------------------|
3+
| SE_SCREEN_WIDTH | 1920 | Use in Node to set the screen width | |
4+
| SE_SCREEN_HEIGHT | 1080 | Use in Node to set the screen height | |
5+
| 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 | |
6+
| SE_FRAME_RATE | 15 | Set the frame rate for FFmpeg in video recording | |
7+
| SE_CODEC | libx264 | Set the codec for FFmpeg in video recording | |
8+
| SE_PRESET | -preset | Set the preset for FFmpeg in video recording | |
9+
| SE_VIDEO_UPLOAD_ENABLED | false | Enable video upload | |
10+
| SE_VIDEO_INTERNAL_UPLOAD | true | Enable video upload using Rclone in the same recorder container | |
11+
| SE_UPLOAD_DESTINATION_PREFIX | | Remote name and destination path to upload | |
12+
| SE_UPLOAD_PIPE_FILE_NAME | | Set the pipe file name for video upload to consume | |
13+
| SE_SERVER_PROTOCOL | http | Protocol for communication between components | |
14+
| SE_VIDEO_POLL_INTERVAL | 1 | | |
15+
| SE_VIDEO_WAIT_ATTEMPTS | | | |
16+
| SE_VIDEO_FILE_READY_WAIT_ATTEMPTS | | | |
17+
| SE_VIDEO_WAIT_UPLOADER_SHUTDOWN_ATTEMPTS | | | |
18+
| SE_LOG_TIMESTAMP_FORMAT | | | |
19+
| SE_VIDEO_RECORD_STANDALONE | | | |
20+
| SE_NODE_PORT | | | --port |
21+
| SE_ROUTER_USERNAME | | Set the username for basic authentication | --username |
22+
| SE_ROUTER_PASSWORD | | Set the password for basic authentication | |
23+
| SE_SUPERVISORD_PID_FILE | /tmp/supervisord.pid | Default pid file will be created by supervisord | |
24+
| SE_DRAIN_AFTER_SESSION_COUNT | 0 | Drain and detach node from grid after session count exceeds | --drain-after-session-count |
25+
| SE_SUB_PATH | | A sub-path that should be considered for all user facing routes on the Hub/Router/Standalone | --sub-path |
26+
| 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 |
27+
| SE_HUB_HOST | | Hub config, host address the Hub should listen on | --host |
28+
| SE_ROUTER_HOST | | Router config, host address the Router should listen on | --host |
29+
| SE_HUB_PORT | | Hub config, port the Hub should listen on (default 4444) | --port |
30+
| SE_ROUTER_PORT | | Router config, port the Router should listen on (default 4444) | --port |
31+
| SE_NODE_GRID_GRAPHQL_URL | | Video recording config, GraphQL URL to query test metadata for dynamic file name | |
32+
| SE_VIDEO_FILE_NAME_TRIM_REGEX | | Bash regex to trim the file name if it is too long | |
33+
| SE_VIDEO_FILE_NAME_SUFFIX | | Append a suffix session id along with test metadata | |
34+
| SE_RCLONE_CONFIG | | | |
35+
| SE_UPLOAD_COMMAND | | | |
36+
| SE_UPLOAD_OPTS | | | |
37+
| SE_UPLOAD_RETAIN_LOCAL_FILE | | | |
38+
| SE_VIDEO_UPLOAD_BATCH_CHECK | | | |
39+
| SE_RCLONE_ | | | |
40+
| SE_OPTS | | | |
41+
| SE_EVENT_BUS_HOST | | | |
42+
| SE_EVENT_BUS_PORT | | | |
43+
| SE_LOG_LEVEL | INFO | | |
44+
| SE_HTTP_LOGS | false | | |
45+
| SE_STRUCTURED_LOGS | false | | |
46+
| SE_EXTERNAL_URL | | | |
47+
| SE_ENABLE_TLS | false | | |
48+
| SE_JAVA_SSL_TRUST_STORE | /opt/selenium/secrets/server.jks | | |
49+
| SE_JAVA_OPTS | | | |
50+
| SE_JAVA_SSL_TRUST_STORE_PASSWORD | /opt/selenium/secrets/server.pass | | |
51+
| SE_JAVA_DISABLE_HOSTNAME_VERIFICATION | true | | |
52+
| SE_HTTPS_CERTIFICATE | /opt/selenium/secrets/tls.crt | | |
53+
| SE_HTTPS_PRIVATE_KEY | /opt/selenium/secrets/tls.key | | |
54+
| SE_ENABLE_TRACING | true | | |
55+
| SE_OTEL_EXPORTER_ENDPOINT | | | |
56+
| SE_OTEL_SERVICE_NAME | selenium-router | | |
57+
| SE_OTEL_JVM_ARGS | | | |
58+
| SE_OTEL_TRACES_EXPORTER | otlp | | |
59+
| SE_OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED | true | | |
60+
| SE_JAVA_HTTPCLIENT_VERSION | HTTP_1_1 | | |
61+
| SE_JAVA_OPTS_DEFAULT | -XX | | |
62+
| SE_JAVA_HEAP_DUMP | false | | |
63+
| SE_BIND_HOST | false | | |
64+
| SE_SCREEN_DEPTH | 24 | | |
65+
| SE_SCREEN_DPI | 96 | | |
66+
| SE_START_XVFB | true | | |
67+
| SE_START_VNC | true | | |
68+
| SE_START_NO_VNC | true | | |
69+
| SE_VNC_ULIMIT | | | |
70+
| SE_NO_VNC_PORT | 7900 | | |
71+
| SE_VNC_PORT | 5900 | | |
72+
| SE_VNC_NO_PASSWORD | | | |
73+
| SE_VNC_VIEW_ONLY | | | |
74+
| SE_VNC_PASSWORD | | | |
75+
| SE_EVENT_BUS_PUBLISH_PORT | | | |
76+
| SE_EVENT_BUS_SUBSCRIBE_PORT | | | |
77+
| SE_NODE_SESSION_TIMEOUT | 300 | | |
78+
| SE_NODE_ENABLE_MANAGED_DOWNLOADS | | | |
79+
| SE_NODE_ENABLE_CDP | | | |
80+
| SE_NODE_REGISTER_PERIOD | | | |
81+
| SE_NODE_REGISTER_CYCLE | | | |
82+
| SE_NODE_HEARTBEAT_PERIOD | 30 | | |
83+
| SE_REGISTRATION_SECRET | | | |
84+
| SE_BROWSER_LEFTOVERS_PROCESSES_SECS | 7200 | | |
85+
| SE_BROWSER_LEFTOVERS_TEMPFILES_DAYS | 1 | | |
86+
| SE_BROWSER_LEFTOVERS_INTERVAL_SECS | 3600 | | |
87+
| SE_DISABLE_UI | | | |
88+
| SE_REJECT_UNSUPPORTED_CAPS | false | | |
89+
| SE_NEW_SESSION_THREAD_POOL_SIZE | | | |
90+
| SE_SESSION_REQUEST_TIMEOUT | 300 | | |
91+
| SE_SESSION_RETRY_INTERVAL | 5 | | |
92+
| SE_HEALTHCHECK_INTERVAL | 120 | | |
93+
| SE_RELAX_CHECKS | true | | |
94+
| SE_SESSION_QUEUE_HOST | | | |
95+
| SE_SESSION_QUEUE_PORT | | | |
96+
| SE_VIDEO_FOLDER | | | |
97+
| SE_LOG_LISTEN_GRAPHQL | | | |
98+
| SE_NODE_PRESTOP_WAIT_STRATEGY | | | |
99+
| SE_SESSIONS_HOST | | | |
100+
| SE_SESSIONS_PORT | | | |
101+
| SE_SESSIONS_MAP_EXTERNAL_DATASTORE | false | | |
102+
| SE_SESSIONS_MAP_HOST | | | |
103+
| SE_SESSIONS_MAP_PORT | | | |
104+
| SE_DISTRIBUTOR_HOST | | | |
105+
| SE_DISTRIBUTOR_PORT | | | |
106+
| SE_GRID_URL | | | |
107+
| SE_NODE_DOCKER_CONFIG_FILENAME | | | |
108+
| SE_NODE_GRACEFUL_SHUTDOWN | | | |
109+
| SE_VIDEO_CONTAINER_NAME | | | |
110+
| SE_RECORD_VIDEO | false | | |
111+
| SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP | false | | |
112+
| SE_NODE_MAX_SESSIONS | 1 | | |
113+
| SE_NODE_OVERRIDE_MAX_SESSIONS | false | | |
114+
| SE_OFFLINE | true | | |
115+
| SE_NODE_BROWSER_VERSION | stable | | |
116+
| SE_NODE_PLATFORM_NAME | Linux | | |
117+
| SE_SUPERVISORD_LOG_LEVEL | info | | |
118+
| SE_SUPERVISORD_CHILD_LOG_DIR | /tmp | | |
119+
| SE_SUPERVISORD_LOG_FILE | /tmp/supervisord.log | | |
120+
| SE_SUPERVISORD_AUTO_RESTART | true | | |
121+
| SE_SUPERVISORD_START_RETRIES | 5 | | |

‎Makefile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@ generate_readme_charts:
8888
$$HOME/go/bin/helm-docs --chart-search-root charts/selenium-grid --output-file CONFIGURATION.md --sort-values-order file ; \
8989
fi
9090

91+
update_list_env_vars:
92+
python3 -m pip install -r tests/requirements.txt ; \
93+
python3 scripts/generate_list_env_vars/extract_env.py
94+
9195
lint_readme_charts: generate_readme_charts
9296
git diff --stat --exit-code ; \
9397
EXIT_CODE=$$? ; \

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Talk to us at https://www.selenium.dev/support/
3434
* [Dev and Beta Channel Browser Images](#dev-and-beta-channel-browser-images)
3535
* [Dev and Beta Standalone Mode](#dev-and-beta-standalone-mode)
3636
* [Dev and Beta on the Grid](#dev-and-beta-on-the-grid)
37+
* [Environment Variables](#environment-variables)
3738
* [Execution modes](#execution-modes)
3839
* [Standalone](#standalone)
3940
* [Hub and Nodes](#hub-and-nodes)
@@ -348,6 +349,10 @@ services:
348349

349350
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/).
350351

352+
## Environment Variables
353+
354+
Checkout full list of environment variables [here](ENV_VARIABLES.md).
355+
351356
## Execution modes
352357

353358
### Standalone

0 commit comments

Comments
 (0)