Merge branch 'main' into brandon-seo-fixes

docs/agent/changelog.md

@@ -6,14 +6,33 @@ title: Changelog
 
 ## v3
 
+### ngrok Agent 3.18.4 - \[2024-11-11\]
+
+- Fixed a bug causing the `--url` flag require an explicit scheme
+
+### ngrok Agent 3.18.3 - \[2024-11-07\]
+
+- Fixed agent diagnose return codes.
+
+### ngrok Agent 3.18.2 - \[2024-10-31\]
+
+- Fixed ngrok diagnose --region all report.
+- Fixed scheme proto defaulting.
+- Added 128 character limit to usernames for agent basic auth.
+
+### ngrok Agent 3.18.1 - \[2024-10-24\]
+
+- Adds binary execution path to the host system metrics collected.
+- Fixed a bug where 4 character time zones were not handled properly in the console UI.
+
 ### ngrok Agent 3.18.0 - \[2024-10-17\]
 
-- Added `--name` field for endpoints and tunnels when created from the agent config or CLI
+- Added `--name` field for endpoints and tunnels when created from the agent config or CLI.
 
 ### ngrok Agent 3.17.0 - \[2024-10-10\]
 
-- Added endpoint create/update/delete subcommands to the ngrok api command
-- Added support for policy phases like `on_tcp_connect`, `on_http_request` and `on_http_response`
+- Added endpoint create/update/delete subcommands to the ngrok api command.
+- Added support for policy phases like `on_tcp_connect`, `on_http_request` and `on_http_response`.
 - Fixed a bug where we were incorrectly passing TLS as the endpoint proto rather than HTTP(S).
 
 ### ngrok Agent 3.16.1 - \[2024-10-03\]

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
 

docs/agent/config/v3.mdx

@@ -316,7 +316,7 @@ endpoint configuration options can be found here.
 
 ### Example
 
-In the snippet below we are defining two endpoints named 'httpbin' and 'demo':
+In the snippet below we are defining two HTTPS endpoints, one TCP endpoint, and one TLS endpoint named 'httpbin', 'demo', 'ssh', and 'demo-2':
 
 ```yaml
 endpoints:
@@ -328,6 +328,14 @@ endpoints:
     url: https://demo.inconshreveable.com
     upstream:
       url: 8181
+  - name: ssh
+    url: tcp://1.tcp.ngrok.io:12345
+    upstream:
+      url: 22
+  - name: demo-2
+    url: tls://myexample.ngrok.app
+    upstream:
+      url: 443
 ```
 
 #### Start the endpoint named 'httpbin'
@@ -350,7 +358,7 @@ ngrok start --all
 | [`url`](#url)                                        |          | The address you would like to use to forward traffic to your upstream service. Leave empty to get a randomly assigned address.                                             |
 | [`metadata`](#metadata-1)                            |          | An arbitrary string of user-defined metadata for this endpoint.                                                                                                            |
 | [`description`](#description)                        |          | An arbitrary user-defined description about this endpoint.                                                                                                                 |
-| [`traffic_policy`](#traffic-policy)                  |          | Accepts a Traffic Policy configuration in YAML format.                                                                                                                     |
+| [`traffic_policy`](#traffic_policy)                  |          | Accepts a Traffic Policy configuration in YAML format.                                                                                                                     |
 | [`upstream`](#upstream)                              | Required | Upstream service configuration options.                                                                                                                                    |
 | [`upstream.url`](#upstreamurl)                       | Required | The address you would like to forward traffic to.                                                                                                                          |
 | [`upstream.protocol`](#upstreamprotocol)             |          | The application layer protocol the agent should use when talking to your upstream application for HTTP endpoints. Accepted values are `http1` (default) and `http2`.       |
@@ -379,9 +387,9 @@ String. The address you would like to use to forward traffic to your upstream se
 
 - **Domain** - `example.org`
   - When using the _domain_ format you are only defining the domain. The scheme and port will be inferred.
-- **Origin** - `https://example.ngrok.app` _or_ `https://example.ngrok.app:443`
-  - When using the _origin_ format you are defining the protocol, domain and port.
-- **Scheme (shorthand)** - `https://`
+- **Origin** - `https://example.ngrok.app` _or_ `https://example.ngrok.app:443` _or_ `tcp://1.tcp.ngrok.io:12345` _or_ `tls://example.ngrok.app`
+  - When using the _origin_ format you are defining the protocol, domain and port. HTTP endpoints accept ports `80` or `443` with respective protocol.
+- **Scheme (shorthand)** - `https://` _or_ `tcp://` _or_ `tls://` _or_ `http://`
   - When using _scheme_ you are defining the protocol and will receive back a randomly assigned ngrok address.
 - **Empty** - ``
   - When _empty_ your endpoint will default to be `https` and receive back a randomly assigned ngrok address.

docs/agent/index.mdx

@@ -33,7 +33,7 @@ CLI for calling the [ngrok API](/api/).
 
 ## Install
 
-Follow the [getting started guide](/getting-started/#step-1-install) or visit the [download page](https://ngrok.com/download) to install and set up the ngrok agent.
+Follow the [getting started guide](/getting-started/#step-1-install) or visit the [download page](https://download.ngrok.com) to install and set up the ngrok agent.
 
 ## Example Usage
 
@@ -374,7 +374,7 @@ details.
 #### Supported Platforms
 
 The ngrok agent runs on all major platforms including Linux, MacOS, Windows and
-most CPU architectures. See the [ngrok agent download](https://ngrok.com/download) page. It is also distributed as a Docker
+most CPU architectures. See the [ngrok agent download](https://download.ngrok.com) page. It is also distributed as a Docker
 container.
 
 | OS      | Supported Architectures                                                                              |

docs/agent/version-support-policy.mdx

@@ -44,7 +44,7 @@ Extended support beyond LTS is available to customers on a commercial basis. It
 
 | Support Status | Release | Release Date | Latest | Active Support | End of Life |
 | -------------- | ------- | ------------ | ------ | -------------- | ----------- |
-| Active         | 3.18x   | 2024-10-17   | 3.18.0 | 2025-10-17     | 2025-12-10  |
+| Active         | 3.18x   | 2024-10-17   | 3.18.4 | 2025-10-17     | 2025-12-17  |
 | Active         | 3.17x   | 2024-10-10   | 3.17.1 | 2025-10-10     | 2025-12-10  |
 | Active         | 3.17x   | 2024-10-10   | 3.17.1 | 2025-10-10     | 2025-12-10  |
 | Active         | 3.16x   | 2024-09-09   | 3.16.1 | 2025-09-09     | 2025-11-09  |

docs/errors/_err_ngrok_list.md

@@ -161,7 +161,7 @@
       </td>
       <td class="pre-wrapped">
         Your <code>&lt;PRODUCT&gt;</code> version "<code>&lt;VERSION&gt;</code>" is no longer supported. Only the most recent version of the ngrok agent is supported without an account.
-        Update to a newer version with `ngrok update`, by downloading from <a href="https://ngrok.com/download">https://ngrok.com/download</a>, or by updating your SDK version.
+        Update to a newer version with `ngrok update`, by downloading from <a href="https://download.ngrok.com">https://download.ngrok.com</a>, or by updating your SDK version.
         Sign up for an account to avoid forced version upgrades: <a href="https://ngrok.com/signup">https://ngrok.com/signup</a>.
       </td>
     </tr>
@@ -170,7 +170,7 @@
         <a id="ERR_NGROK_121" href="/docs/errors/err_ngrok_121">ERR_NGROK_121</a>
       </td>
       <td class="pre-wrapped">
-        Your <code>&lt;PRODUCT&gt;</code> version "<code>&lt;VERSION&gt;</code>" is too old. The minimum supported agent version for your account is "<code>&lt;MINVERSION&gt;</code>". Please update to a newer version with `ngrok update`, by downloading from <a href="https://ngrok.com/download">https://ngrok.com/download</a>, or by updating your SDK version. Paid accounts are currently excluded from minimum agent version requirements. To begin handling traffic immediately without updating your agent, upgrade to a paid plan: <a href="https://dashboard.ngrok.com/billing/subscription">https://dashboard.ngrok.com/billing/subscription</a>.
+        Your <code>&lt;PRODUCT&gt;</code> version "<code>&lt;VERSION&gt;</code>" is too old. The minimum supported agent version for your account is "<code>&lt;MINVERSION&gt;</code>". Please update to a newer version with `ngrok update`, by downloading from <a href="https://download.ngrok.com">https://download.ngrok.com</a>, or by updating your SDK version. Paid accounts are currently excluded from minimum agent version requirements. To begin handling traffic immediately without updating your agent, upgrade to a paid plan: <a href="https://dashboard.ngrok.com/billing/subscription">https://dashboard.ngrok.com/billing/subscription</a>.
       </td>
     </tr>
     <tr>

docs/errors/err_ngrok_120.mdx

@@ -10,7 +10,7 @@ import ErrorDetails from "/src/components/ErrorDetails";
 ### Message
 
 Your `PRODUCT` version "`VERSION`" is no longer supported. Only the most recent version of the ngrok agent is supported without an account.
-Update to a newer version with `ngrok update`, by downloading from https://ngrok.com/download, or by updating your SDK version.
+Update to a newer version with `ngrok update`, by downloading from https://download.ngrok.com, or by updating your SDK version.
 Sign up for an account to avoid forced version upgrades: https://ngrok.com/signup.
 
 <ErrorDetails error="err_ngrok_120" />

docs/errors/err_ngrok_121.mdx

@@ -9,7 +9,7 @@ import ErrorDetails from "/src/components/ErrorDetails";
 
 ### Message
 
-Your `PRODUCT` version "`VERSION`" is too old. The minimum supported agent version for your account is "`MINVERSION`". Please update to a newer version with `ngrok update`, by downloading from https://ngrok.com/download, or by updating your SDK version. Paid accounts are currently excluded from minimum agent version requirements. To begin handling traffic immediately without updating your agent, upgrade to a paid plan: https://dashboard.ngrok.com/billing/subscription.
+Your `PRODUCT` version "`VERSION`" is too old. The minimum supported agent version for your account is "`MINVERSION`". Please update to a newer version with `ngrok update`, by downloading from https://download.ngrok.com, or by updating your SDK version. Paid accounts are currently excluded from minimum agent version requirements. To begin handling traffic immediately without updating your agent, upgrade to a paid plan: https://dashboard.ngrok.com/billing/subscription.
 
 <ErrorDetails error="err_ngrok_121" />
 

docs/errors/index.html

@@ -166,7 +166,7 @@
 				Your ngrok agent version "<code>&lt;VERSION&gt;</code>" is no longer
 				supported. Only the most recent version of the ngrok agent is supported
 				without an account. Update to a newer version with `ngrok update` or by
-				downloading from https://ngrok.com/download. Sign up for an account to
+				downloading from https://download.ngrok.com. Sign up for an account to
 				avoid forced version upgrades: https://ngrok.com/signup.
 			</td>
 		</tr>
@@ -178,7 +178,7 @@
 				Your ngrok agent version "<code>&lt;VERSION&gt;</code>" is too old. The
 				minimum supported agent version for your account is
 				"<code>&lt;MINVERSION&gt;</code>". Please update to a newer version with
-				`ngrok update` or by downloading from https://ngrok.com/download.
+				`ngrok update` or by downloading from https://download.ngrok.com.
 			</td>
 		</tr>
 		<tr>

docs/errors/index.md

@@ -37,7 +37,7 @@ listed here to help make your troubleshooting easier.
 | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [ERR_NGROK_100](/docs/errors/err_ngrok_100)   | Invalid metadata length                                                                                                                                                                                                                                                                                                         |
 | [ERR_NGROK_108](/docs/errors/err_ngrok_108)   | You've hit your account limit for simultaneous ngrok agent sessions. Try stopping an existing agent or upgrading your account.                                                                                                                                                                                                  |
-| [ERR_NGROK_120](/docs/errors/err_ngrok_120)   | Your ngrok agent version `VERSION` is no longer supported. Only the most recent version of the ngrok agent is supported without an account. Update to a newer version with `ngrok update` or by downloading from https://ngrok.com/download. Sign up for an account to avoid forced version upgrades: https://ngrok.com/signup. |
+| [ERR_NGROK_120](/docs/errors/err_ngrok_120)   | Your ngrok agent version `VERSION` is no longer supported. Only the most recent version of the ngrok agent is supported without an account. Update to a newer version with `ngrok update` or by downloading from https://download.ngrok.com. Sign up for an account to avoid forced version upgrades: https://ngrok.com/signup. |
 | [ERR_NGROK_1205](/docs/errors/err_ngrok_1205) | You failed to solve the catpcha, please try again.                                                                                                                                                                                                                                                                              |
 | [ERR_NGROK_1226](/docs/errors/err_ngrok_1226) | You are disallowed from creating an ngrok account due to violation of the terms of service.                                                                                                                                                                                                                                     |
 | [ERR_NGROK_3004](/docs/errors/err_ngrok_3004) | ngrok gateway error. The server returned an invalid or incomplete HTTP response. Try starting ngrok with the full upstream service URL (e.g. ngrok http https://localhost:8081)                                                                                                                                                 |