Container CLI
Configure and manage your Nestri Relay environment using CLI parameters for WebRTC settings, STUN servers, local IP handling, and TLS options.
The Nestri Relay CLI provides configuration parameters to manage your relay environment. These options allow you to set values like WebRTC ports, STUN servers, and TLS certificates. Additionally, you can enable verbose mode and debugging for troubleshooting purposes. This documentation details each parameter to help you optimize your relay setup effectively.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
-v, --verbose | boolean | false | Shows more logs; useful for debugging issues. Recommended before reporting problems. |
-d, --debug | boolean | false | Enables debugging mode for additional logs and troubleshooting insights. |
-p, --endpointPort | integer | 8088 | Specifies the main port for the relay endpoint. |
| WebRTC Settings | |||
--webrtcUDPStart | integer | 10000 | Defines the starting UDP port for WebRTC connections. |
--webrtcUDPEnd | integer | 20000 | Defines the ending UDP port for WebRTC connections. |
--webrtcUDPMux | integer | 8088 | Specifies the WebRTC UDP multiplexing port. |
--stunServer | string | stun.l.google.com:19302 | Defines the STUN server address for NAT traversal. |
--autoAddLocalIP | boolean | true | Automatically adds local IP addresses to WebRTC candidates. |
--WEBRTC_NAT_IPS | string | "" | Comma-separated list of public IPs for WebRTC NAT traversal (e.g., "192.168.0.1,192.168.0.2"). |
| TLS Configuration | |||
--tlsCert | string | "" | Path to the TLS certificate file for secure connections. |
--tlsKey | string | "" | Path to the TLS private key file for secure connections. |