Skip to content

Commit f00a8b0

Browse files
amathur-LTamathur-LT
committed
Update tunnel modifiers documentation to include new flags and descriptions
1 parent 1787967 commit f00a8b0

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

‎docs/lambda-tunnel-modifiers.md‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -48,43 +48,43 @@ LambdaTest Tunnel provides several command-line arguments that you can leverage
4848

4949
This document will help you understand all the modifiers/arguments used with LambdaTest Tunnel to help you test your locally hosted web pages.
5050

51-
| FLAG (SHORT) | FLAG (LONG) | DESCRIPTION | TYPE |
52-
|--------------|-------------|-------------|------|
53-
|| --allowHosts | Comma separated list of hosts to route via tunnel. Everything else will be routed via Internet. <br /> Learn how to use the [wildcard expressions](https://www.lambdatest.com/support/docs/tunnel-allowHost-wildcard-support/) in the `--allowHosts` flag | String |
54-
| | --bypassHosts | Comma separated list of hosts to bypass from tunnel. These will be routed via internet. | String |
55-
| | --callbackURL | Callback URL for tunnel status. | String |
56-
| -c | --config | Path of the config file to use | String |
57-
| | --clientCert | mTLS Client Certificate filepath. Only `pfx` file type is supported| String |
58-
| | --clientKey | mTLS Client Key filepath. | String |
59-
| | --mTLSHosts | Comma separated list of mTLS hosts. | String |
60-
| -d | --dir | Specify the Local Directory that will be server by a file server on port 33000 | String |
61-
| | --dns | Comma Separated List of DNS Servers | String |
62-
| | --egress-only | Uses proxy settings only for outbound requests. | N/A |
63-
| -e | --env | The environment on which the LambdaTest Tunnel will run. | String |
64-
| -h | --help | Help for the LambdaTest Tunnel | N/A |
65-
| | --infoAPIPort | Exposes [Tunnel Info API](https://www.lambdatest.com/support/docs/advanced-tunnel-features/#tunnelinfoapis) At The Specified Port | Integer |
66-
| | --ingress-only | Routes Only Incoming Traffic Via The Proxy Specified | N/A |
67-
| -k | --key | LambdaTest Access Key. | String |
68-
| -l | --load-balanced | Activates [Load Balancing](https://www.lambdatest.com/support/docs/load-balancing-in-lambda-tunnel/) for LambdaTest Tunnel | N/A |
69-
| | --logFile | Location of the LambdaTest Tunnel Log File | String |
70-
| -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 |
71-
| | --mode | Specifies in which mode tunnel should run [ssh,ws]. (default "ssh") | String |
72-
| | --ntlm | To use Microsoft NTLM (Windows NT LAN Manager) authentication for communication or transport purposes. | Boolean |
73-
| | --pidfile | Path Of Pidfile, Where Process ID will Be Written | String |
74-
| -p | --port | Port for LambdaTest Tunnel to activate. | Integer |
75-
| | --proxy-host | Specifies the Tunnel Proxy Port hostname. | String |
76-
| | --proxy-pass | Specifies the Tunnel Proxy Port password. | String |
77-
| | --proxy-port | Specifies the port number where Tunnel proxy will activate. | Integer |
78-
| | --proxy-user | Specifies the Tunnel Proxy Port username | String |
79-
| | --pacfile | Path of a PAC file. | String |
80-
| -s | --shared-tunnel | Sharing Tunnel Among Team Members | N/A |
81-
| | --sshConnType | Specify type of ssh connection (over_22, over_443, over_ws).To use –sshConnType, specify ––mode ssh flag first. | String |
82-
| N/A | --maxSSHConnections | Increase the SSH Connection from Tunnel Client to Tunnel Server. Maximum allow is 30 | N/A |
83-
| -n | --tunnelName | Specifies the custom LambdaTest Tunnel name to be used. | String |
84-
| -u | --user | LambdaTest Username. | String |
85-
| | --use-private-ip | Sets remote address to an internal IP of client machine. | Boolean |
86-
| -v | --verbose | Should Every Proxy Request Be Logged To Stdout | N/A |
87-
| | --version | Displays the installed version for LambdaTest Tunnel | N/A |
51+
| FLAG (SHORT) | FLAG (LONG) | DESCRIPTION | TYPE |
52+
|--------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|
53+
|| --allowHosts | Comma separated list of hosts to route via tunnel. Everything else will be routed via Internet. <br /> Learn how to use the [wildcard expressions](https://www.lambdatest.com/support/docs/tunnel-allowHost-wildcard-support/) in the `--allowHosts` flag | String |
54+
| | --bypassHosts | Comma separated list of hosts to bypass from tunnel. These will be routed via internet. | String |
55+
| | --callbackURL | Callback URL for tunnel status. | String |
56+
| -c | --config | Path of the config file to use | String |
57+
| | --clientCert | mTLS Client Certificate filepath. Only `pfx` file type is supported | String |
58+
| | --clientKey | mTLS Client Key filepath. | String |
59+
| | --mTLSHosts | Comma separated list of mTLS hosts. | String |
60+
| -d | --dir | Specify the Local Directory that will be server by a file server on port 33000 | String |
61+
| | --dns | Comma Separated List of DNS Servers | String |
62+
| | --egress-only | Uses proxy settings only for outbound requests. | N/A |
63+
| -e | --env | The environment on which the LambdaTest Tunnel will run. | String |
64+
| -h | --help | Help for the LambdaTest Tunnel | N/A |
65+
| | --infoAPIPort | Exposes [Tunnel Info API](https://www.lambdatest.com/support/docs/advanced-tunnel-features/#tunnelinfoapis) At The Specified Port | Integer |
66+
| | --ingress-only | Routes Only Incoming Traffic Via The Proxy Specified | N/A |
67+
| -k | --key | LambdaTest Access Key. | String |
68+
| -l | --load-balanced | Activates [Load Balancing](https://www.lambdatest.com/support/docs/load-balancing-in-lambda-tunnel/) for LambdaTest Tunnel | N/A |
69+
| | --logFile | Location of the LambdaTest Tunnel Log File | String |
70+
| -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 |
71+
| | --mode | Specifies in which mode tunnel should run [ssh,ws,tcp]. (default "ssh") | String |
72+
| | --ntlm | To use Microsoft NTLM (Windows NT LAN Manager) authentication for communication or transport purposes. | Boolean |
73+
| | --pidfile | Path Of Pidfile, Where Process ID will Be Written | String |
74+
| -p | --port | Port for LambdaTest Tunnel to activate. | Integer |
75+
| | --proxy-host | Specifies the Tunnel Proxy Port hostname. | String |
76+
| | --proxy-pass | Specifies the Tunnel Proxy Port password. | String |
77+
| | --proxy-port | Specifies the port number where Tunnel proxy will activate. | Integer |
78+
| | --proxy-user | Specifies the Tunnel Proxy Port username | String |
79+
| | --pacfile | Path of a PAC file. | String |
80+
| -s | --shared-tunnel | Sharing Tunnel Among Team Members | N/A |
81+
| | --sshConnType | Specify type of ssh connection (over_22, over_443, over_ws).To use –sshConnType, specify ––mode ssh flag first. | String |
82+
| N/A | --maxSSHConnections | Increase the SSH Connection from Tunnel Client to Tunnel Server. Maximum allow is 30 | N/A |
83+
| -n | --tunnelName | Specifies the custom LambdaTest Tunnel name to be used. | String |
84+
| -u | --user | LambdaTest Username. | String |
85+
| | --use-private-ip | Sets remote address to an internal IP of client machine. | Boolean |
86+
| -v | --verbose | Should Every Proxy Request Be Logged To Stdout | N/A |
87+
| | --version | Displays the installed version for LambdaTest Tunnel | N/A |
8888

8989
<nav aria-label="breadcrumbs">
9090
<ul className="breadcrumbs">

0 commit comments

Comments
 (0)