update docs to include cli flag renames

ngrok · Sep 26, 2024 · 2750d79 · 2750d79
1 parent c590142
commit 2750d79
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 21 deletions.
diff --git a/docs/agent/cli.mdx b/docs/agent/cli.mdx
@@ -406,7 +406,7 @@ ngrok http https://localhost:8443           # forward to a local https server
 | `--oauth-client-secret string`       | oauth app client id, optional                                                                                      |
 | `--oauth-scope strings`              | request these OAuth2 scopes when users authenticate                                                                |
 | `--policy-file string` (Deprecated)  | use `--traffic-policy-file` instead                                                                                |
-| `--proxy-proto string`               | version of PROXY protocol to use with this tunnel, empty if not using. Example values are 1 or 2.                  |
+| `--upstream-proxy-protocol string`   | version of PROXY protocol to use with this tunnel, empty if not using. Example values are 1 or 2.                  |
 | `--region string` (Deprecated)       | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (defaults to closest)                     |
 | `--request-header-add strings`       | header key:value to add to request                                                                                 |
 | `--request-header-remove strings`    | header field to remove from request if present                                                                     |
@@ -524,7 +524,7 @@ ngrok tcp --remote-addr=1.tcp.ngrok.io:27210 3389
 | `--log-format string`               | log record format: `term`, `logfmt`, `json` (default `term`)                                                      |
 | `--log-level string`                | `debug`, `info`, `warn`, `error`, `crit` (default `info`)                                                         |
 | `--traffic-policy-file string`      | path to traffic policy configuration YAML or JSON file (See [Traffic Policy](/tcp/traffic-policy/?cty=agent-cli)) |
-| `--proxy-proto string`              | version of proxy proto to use with this tunnel, empty if not using                                                |
+| `--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)                                                          |
@@ -577,7 +577,7 @@ ngrok tls --url=t.co --crt=/path/to/t.co.crt --key=/path/to/t.co.key 443
 | `--log-level string`                | `debug`, `info`, `warn`, `error`, `crit` (default `info`)                                                               |
 | `--mutual-tls-cas string`           | path to TLS certificate authority to verify client certs in mutual TLS                                                  |
 | `--traffic-policy-file string`      | path to traffic policy configuration YAML or JSON file (See [Traffic Policy](/tls/traffic-policy/?cty=agent-cli))       |
-| `--proxy-proto string`              | version of proxy proto to use with this tunnel, empty if not using                                                      |
+| `--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` (defaults to closest)                          |
 | `--terminate-at string`             | terminate at ngrok "edge", "agent" or "upstream. Defaults to no termination or "edge" if `--crt` or `--key` are present |
@@ -608,20 +608,20 @@ ngrok tunnel [--label key:value] ... [address:port | port] [flags]
 
 ### Flags
 
-| Flag                   | Description                                                                                    |
-| ---------------------- | ---------------------------------------------------------------------------------------------- |
-| `--authtoken string`   | ngrok authtoken identifying a user                                                             |
-| `--config strings`     | path to config files; they are merged if multiple                                              |
-| `--crt string`         | path to a TLS certificate for TLS termination                                                  |
-| `-h`, `--help`         | help for this command                                                                          |
-| `--inspect`            | enable/disable http introspection (default true)                                               |
-| `--key string`         | path to a TLS key for TLS termination                                                          |
-| `--label strings`      | labels to associate with the tunnel in key=value format                                        |
-| `--log string`         | path to log file, `stdout`, `stderr` or `false` (default `false`)                              |
-| `--log-format string`  | log record format: `term`, `logfmt`, `json` (default `term`)                                   |
-| `--log-level string`   | `debug`, `info`, `warn`, `error`, `crit` (default `info`)                                      |
-| `--proxy-proto string` | version of proxy proto to use with this tunnel, empty if not using                             |
-| `--region string`      | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (defaults to closest) |
+| Flag                               | Description                                                                                    |
+| ---------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `--authtoken string`               | ngrok authtoken identifying a user                                                             |
+| `--config strings`                 | path to config files; they are merged if multiple                                              |
+| `--crt string`                     | path to a TLS certificate for TLS termination                                                  |
+| `-h`, `--help`                     | help for this command                                                                          |
+| `--inspect`                        | enable/disable http introspection (default true)                                               |
+| `--key string`                     | path to a TLS key for TLS termination                                                          |
+| `--label strings`                  | labels to associate with the tunnel in key=value format                                        |
+| `--log string`                     | path to log file, `stdout`, `stderr` or `false` (default `false`)                              |
+| `--log-format string`              | log record format: `term`, `logfmt`, `json` (default `term`)                                   |
+| `--log-level string`               | `debug`, `info`, `warn`, `error`, `crit` (default `info`)                                      |
+| `--upstream-proxy-protocol string` | version of proxy proto to use with this tunnel, empty if not using                             |
+| `--region string`                  | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (defaults to closest) |
 
 ## ngrok update
 

diff --git a/examples/agent-cli/tcp-proxyproto.mdx b/examples/agent-cli/tcp-proxyproto.mdx
@@ -1,3 +1,3 @@
 ```bash
-ngrok tcp 22 --proxy-proto=2
+ngrok tcp 22 --upstream-proxy-protocol=2
 ```
diff --git a/examples/agent-cli/tls-proxyproto.mdx b/examples/agent-cli/tls-proxyproto.mdx
@@ -1,3 +1,3 @@
 ```bash
-ngrok tls 443 --proxy-proto=2
+ngrok tls 443 --upstream-proxy-protocol=2
 ```
diff --git a/examples/agent-config/tcp-proxyproto.mdx b/examples/agent-config/tcp-proxyproto.mdx
@@ -3,5 +3,5 @@ tunnels:
   example:
     proto: tcp
     addr: 22
-    proxy_proto: 2
+    proxy_protocol: 2
 ```
diff --git a/examples/agent-config/tls-proxyproto.mdx b/examples/agent-config/tls-proxyproto.mdx
@@ -3,5 +3,5 @@ tunnels:
   example:
     proto: tls
     addr: 443
-    proxy_proto: 2
+    proxy_protocol: 2
 ```