Merge branch 'main' into joelhans/ccg

ngrok · Oct 25, 2024 · ab8e25e · ab8e25e
2 parents e1d022e + d0dfaca
commit ab8e25e
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/docs/agent/cli.mdx b/docs/agent/cli.mdx
@@ -371,8 +371,8 @@ ngrok http [address:port | port] [flags]
 ```sh
 ngrok http 8080                             # forwards provided ngrok URL to port 80
 ngrok http example.com:9000                 # forward traffic to example.com:9000
-ngrok http --url=bar.ngrok.dev 80        # request subdomain name: 'bar.ngrok.dev'
-ngrok http --url=www.ex.com 1234         # request tunnel 'www.ex.com' (DNS CNAME)
+ngrok http --url=bar.ngrok.dev 80           # request subdomain name: 'bar.ngrok.dev'
+ngrok http --url=www.ex.com 1234            # request tunnel 'www.ex.com' (DNS CNAME)
 ngrok http --basic-auth='falken:joshua' 80  # enforce basic auth on tunnel endpoint
 ngrok http --host-header=ex.com 80          # rewrite the Host header to 'ex.com'
 ngrok http file:///var/log                  # serve local files in /var/log
@@ -487,7 +487,7 @@ ngrok start --all      # start all tunnels defined in the config file
 
 Use `ngrok tcp` to start a TCP tunnel which forwards all traffic on a public port to a local address. This is extremely useful for exposing services that run non-HTTP traffic (SSH, SIP, RDP, RTSP, GRPC, game servers, etc).
 
-A TCP tunnel binds a public address on the remote ngrok server. Any services which require a stable public address should use the `--remote-addr` option. ngrok requires that you reserve a TCP tunnel address for your account before you can use it.
+A TCP tunnel binds a public address on the remote ngrok server. Any services which require a stable public address should use the `--url` option. ngrok requires that you reserve a TCP tunnel address for your account before you can use it.
 
 ::::warning
 TCP endpoints are only available on a free plan after [adding a valid payment method](https://dashboard.ngrok.com/settings#id-verification) to your account.
@@ -508,7 +508,7 @@ ngrok tcp 22
 
 ```sh
 # expose an RDP server on a specific public address that you reserved
-ngrok tcp --remote-addr=1.tcp.ngrok.io:27210 3389
+ngrok tcp --url=tcp://1.tcp.ngrok.io:27210 3389
 ```
 
 ### Flags
@@ -527,7 +527,8 @@ ngrok tcp --remote-addr=1.tcp.ngrok.io:27210 3389
 | `--upstream-proxy-protocol string`  | version of proxy proto to use with this tunnel, empty if not using                                                |
 | `--policy-file string` (Deprecated) | use `--traffic-policy-file` instead                                                                               |
 | `--region string`                   | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (default to closest)                     |
-| `--remote-addr string`              | bind remote address (requires you reserve a TCP Address)                                                          |
+| `--remote-addr string` (Deprecated) | bind remote address (requires you reserve a TCP Address)                                                          |
+| `--url string`                      | bind remote address (requires you reserve a TCP Address)                                                          |
 
 ## ngrok tls