From f00a8b0874a2bc16a131e24232bc62e736a8e66f Mon Sep 17 00:00:00 2001 From: Ankit Mathur Date: Thu, 14 Aug 2025 12:10:12 +0530 Subject: [PATCH 1/3] Update tunnel modifiers documentation to include new flags and descriptions --- docs/lambda-tunnel-modifiers.md | 74 ++++++++++++++++----------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/lambda-tunnel-modifiers.md b/docs/lambda-tunnel-modifiers.md index 5b4d9aace..6b1a27f07 100644 --- a/docs/lambda-tunnel-modifiers.md +++ b/docs/lambda-tunnel-modifiers.md @@ -48,43 +48,43 @@ LambdaTest Tunnel provides several command-line arguments that you can leverage This document will help you understand all the modifiers/arguments used with LambdaTest Tunnel to help you test your locally hosted web pages. -| FLAG (SHORT) | FLAG (LONG) | DESCRIPTION | TYPE | -|--------------|-------------|-------------|------| -|| --allowHosts | Comma separated list of hosts to route via tunnel. Everything else will be routed via Internet.
Learn how to use the [wildcard expressions](https://www.lambdatest.com/support/docs/tunnel-allowHost-wildcard-support/) in the `--allowHosts` flag | String | -| | --bypassHosts | Comma separated list of hosts to bypass from tunnel. These will be routed via internet. | String | -| | --callbackURL | Callback URL for tunnel status. | String | -| -c | --config | Path of the config file to use | String | -| | --clientCert | mTLS Client Certificate filepath. Only `pfx` file type is supported| String | -| | --clientKey | mTLS Client Key filepath. | String | -| | --mTLSHosts | Comma separated list of mTLS hosts. | String | -| -d | --dir | Specify the Local Directory that will be server by a file server on port 33000 | String | -| | --dns | Comma Separated List of DNS Servers | String | -| | --egress-only | Uses proxy settings only for outbound requests. | N/A | -| -e | --env | The environment on which the LambdaTest Tunnel will run. | String | -| -h | --help | Help for the LambdaTest Tunnel | N/A | -| | --infoAPIPort | Exposes [Tunnel Info API](https://www.lambdatest.com/support/docs/advanced-tunnel-features/#tunnelinfoapis) At The Specified Port | Integer | -| | --ingress-only | Routes Only Incoming Traffic Via The Proxy Specified | N/A | -| -k | --key | LambdaTest Access Key. | String | -| -l | --load-balanced | Activates [Load Balancing](https://www.lambdatest.com/support/docs/load-balancing-in-lambda-tunnel/) for LambdaTest Tunnel | N/A | -| | --logFile | Location of the LambdaTest Tunnel Log File | String | -| -m | --mitm | Enable the [MITM(Man-in-the-middle)](https://www.lambdatest.com/support/docs/advanced-tunnel-features/#mitmlocaltesting) mode for LambdaTest Tunnel | N/A | -| | --mode | Specifies in which mode tunnel should run [ssh,ws]. (default "ssh") | String | -| | --ntlm | To use Microsoft NTLM (Windows NT LAN Manager) authentication for communication or transport purposes. | Boolean | -| | --pidfile | Path Of Pidfile, Where Process ID will Be Written | String | -| -p | --port | Port for LambdaTest Tunnel to activate. | Integer | -| | --proxy-host | Specifies the Tunnel Proxy Port hostname. | String | -| | --proxy-pass | Specifies the Tunnel Proxy Port password. | String | -| | --proxy-port | Specifies the port number where Tunnel proxy will activate. | Integer | -| | --proxy-user | Specifies the Tunnel Proxy Port username | String | -| | --pacfile | Path of a PAC file. | String | -| -s | --shared-tunnel | Sharing Tunnel Among Team Members | N/A | -| | --sshConnType | Specify type of ssh connection (over_22, over_443, over_ws).To use –sshConnType, specify ––mode ssh flag first. | String | -| N/A | --maxSSHConnections | Increase the SSH Connection from Tunnel Client to Tunnel Server. Maximum allow is 30 | N/A | -| -n | --tunnelName | Specifies the custom LambdaTest Tunnel name to be used. | String | -| -u | --user | LambdaTest Username. | String | -| | --use-private-ip | Sets remote address to an internal IP of client machine. | Boolean | -| -v | --verbose | Should Every Proxy Request Be Logged To Stdout | N/A | -| | --version | Displays the installed version for LambdaTest Tunnel | N/A | +| FLAG (SHORT) | FLAG (LONG) | DESCRIPTION | TYPE | +|--------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +|| --allowHosts | Comma separated list of hosts to route via tunnel. Everything else will be routed via Internet.
Learn how to use the [wildcard expressions](https://www.lambdatest.com/support/docs/tunnel-allowHost-wildcard-support/) in the `--allowHosts` flag | String | +| | --bypassHosts | Comma separated list of hosts to bypass from tunnel. These will be routed via internet. | String | +| | --callbackURL | Callback URL for tunnel status. | String | +| -c | --config | Path of the config file to use | String | +| | --clientCert | mTLS Client Certificate filepath. Only `pfx` file type is supported | String | +| | --clientKey | mTLS Client Key filepath. | String | +| | --mTLSHosts | Comma separated list of mTLS hosts. | String | +| -d | --dir | Specify the Local Directory that will be server by a file server on port 33000 | String | +| | --dns | Comma Separated List of DNS Servers | String | +| | --egress-only | Uses proxy settings only for outbound requests. | N/A | +| -e | --env | The environment on which the LambdaTest Tunnel will run. | String | +| -h | --help | Help for the LambdaTest Tunnel | N/A | +| | --infoAPIPort | Exposes [Tunnel Info API](https://www.lambdatest.com/support/docs/advanced-tunnel-features/#tunnelinfoapis) At The Specified Port | Integer | +| | --ingress-only | Routes Only Incoming Traffic Via The Proxy Specified | N/A | +| -k | --key | LambdaTest Access Key. | String | +| -l | --load-balanced | Activates [Load Balancing](https://www.lambdatest.com/support/docs/load-balancing-in-lambda-tunnel/) for LambdaTest Tunnel | N/A | +| | --logFile | Location of the LambdaTest Tunnel Log File | String | +| -m | --mitm | Enable the [MITM(Man-in-the-middle)](https://www.lambdatest.com/support/docs/advanced-tunnel-features/#mitmlocaltesting) mode for LambdaTest Tunnel | N/A | +| | --mode | Specifies in which mode tunnel should run [ssh,ws,tcp]. (default "ssh") | String | +| | --ntlm | To use Microsoft NTLM (Windows NT LAN Manager) authentication for communication or transport purposes. | Boolean | +| | --pidfile | Path Of Pidfile, Where Process ID will Be Written | String | +| -p | --port | Port for LambdaTest Tunnel to activate. | Integer | +| | --proxy-host | Specifies the Tunnel Proxy Port hostname. | String | +| | --proxy-pass | Specifies the Tunnel Proxy Port password. | String | +| | --proxy-port | Specifies the port number where Tunnel proxy will activate. | Integer | +| | --proxy-user | Specifies the Tunnel Proxy Port username | String | +| | --pacfile | Path of a PAC file. | String | +| -s | --shared-tunnel | Sharing Tunnel Among Team Members | N/A | +| | --sshConnType | Specify type of ssh connection (over_22, over_443, over_ws).To use –sshConnType, specify ––mode ssh flag first. | String | +| N/A | --maxSSHConnections | Increase the SSH Connection from Tunnel Client to Tunnel Server. Maximum allow is 30 | N/A | +| -n | --tunnelName | Specifies the custom LambdaTest Tunnel name to be used. | String | +| -u | --user | LambdaTest Username. | String | +| | --use-private-ip | Sets remote address to an internal IP of client machine. | Boolean | +| -v | --verbose | Should Every Proxy Request Be Logged To Stdout | N/A | +| | --version | Displays the installed version for LambdaTest Tunnel | N/A |