Skip to content

Commit 94fff6d

Browse files
committed
Allow external uri to be configurable for components that support server functionality.
SE nodes might be behind some sort of proxy exposed to hub on a different hostname(/ip) and/or port than component would by default report themselves (e.g.: hub and nodes are in different k8s clusters and services are exposed via node ports). Fixes #12491
1 parent d1af4fe commit 94fff6d

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

website_and_docs/content/documentation/grid/configuration/cli_options.en.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -248,15 +248,16 @@ pull request updating this page.
248248

249249
### Server
250250

251-
| Option | Type | Value/Example | Description |
252-
|---|---|---|---|
253-
| `--allow-cors` | boolean | `true` | Whether the Selenium server should allow web browser connections from any host |
254-
| `--host` | string | `localhost` | Server IP or hostname: usually determined automatically. |
255-
| `--bind-host` | boolean | `true` | Whether the server should bind to the host address/name, or only use it to" report its reachable url. Helpful in complex network topologies where the server cannot report itself with the current IP/hostname but rather an external IP or hostname (e.g. inside a Docker container) |
256-
| `--https-certificate` | path | `/path/to/cert.pem` | Server certificate for https. Get more detailed information by running "java -jar selenium-server.jar info security" |
257-
| `--https-private-key` | path | `/path/to/key.pkcs8` | Private key for https. Get more detailed information by running "java -jar selenium-server.jar info security" |
258-
| `--max-threads` | int | `24` | Maximum number of listener threads. Default value is: (available processors) * 3. |
259-
| `--port` | int | `4444` | Port to listen on. There is no default as this parameter is used by different components, for example, Router/Hub/Standalone will use 4444 and Node will use 5555. |
251+
| Option | Type | Value/Example | Description |
252+
|-----------------------|---------|---|---|
253+
| `--external-uri` | string | `http://10.0.1.1:33333` | External URI where component is generally available. Useful on complex network topologies when components are on different networks and proxy servers are involved. |
254+
| `--allow-cors` | boolean | `true` | Whether the Selenium server should allow web browser connections from any host |
255+
| `--host` | string | `localhost` | Server IP or hostname: usually determined automatically. |
256+
| `--bind-host` | boolean | `true` | Whether the server should bind to the host address/name, or only use it to" report its reachable url. Helpful in complex network topologies where the server cannot report itself with the current IP/hostname but rather an external IP or hostname (e.g. inside a Docker container) |
257+
| `--https-certificate` | path | `/path/to/cert.pem` | Server certificate for https. Get more detailed information by running "java -jar selenium-server.jar info security" |
258+
| `--https-private-key` | path | `/path/to/key.pkcs8` | Private key for https. Get more detailed information by running "java -jar selenium-server.jar info security" |
259+
| `--max-threads` | int | `24` | Maximum number of listener threads. Default value is: (available processors) * 3. |
260+
| `--port` | int | `4444` | Port to listen on. There is no default as this parameter is used by different components, for example, Router/Hub/Standalone will use 4444 and Node will use 5555. |
260261

261262
### SessionQueue
262263

0 commit comments

Comments
 (0)