diff --git a/docs/agent/cli.mdx b/docs/agent/cli.mdx index d1964a1fd..530705666 100644 --- a/docs/agent/cli.mdx +++ b/docs/agent/cli.mdx @@ -412,7 +412,6 @@ ngrok http https://localhost:8443 # forward to a local https server | `--request-header-remove strings` | header field to remove from request if present | | `--response-header-add strings` | header key:value to add to response | | `--response-header-remove strings` | header field to remove from response if present | -| `--scheme strings` | which scheme to listen on (default `https`) | | `--traffic-policy-file string` | path to traffic policy configuration YAML or JSON file (See [Traffic Policy](/http/traffic-policy/?cty=agent-cli)) | | `--ua-filter-allow strings` | a list of regular expressions for user-agents to allow | | `--ua-filter-deny strings` | a list of regular expressions for user-agents to deny | diff --git a/docs/agent/config.mdx b/docs/agent/config.mdx index 37394e6be..2cfe0ce71 100644 --- a/docs/agent/config.mdx +++ b/docs/agent/config.mdx @@ -493,7 +493,7 @@ tunnels: ngrok start httpbin ``` -Each tunnel you define is a map of configuration option names to values. The name of a configuration option is usually the same as its corresponding command line switch with hyphens (`--host-header` becomes `host_header:` in the configuration file and `--scheme` becomes `schemes`). Tunnels can define a specific `proto` or use labels to dynamically connect to one or more matching ngrok Edges. All tunnels must define a specific `addr` that tells the agent where to send the traffic. Other properties are available and many are protocol-specific. +Each tunnel you define is a map of configuration option names to values. The name of a configuration option is usually the same as its corresponding command line switch with hyphens (`--host-header` becomes `host_header:` in the configuration file and `--url` becomes `url`). Tunnels can define a specific `proto` or use labels to dynamically connect to one or more matching ngrok Edges. All tunnels must define a specific `addr` that tells the agent where to send the traffic. Other properties are available and many are protocol-specific. ##### Start all tunnels defined in the configuration file diff --git a/docs/errors/details/_err_ngrok_3200.md b/docs/errors/details/_err_ngrok_3200.md index ead34f800..af4a53140 100644 --- a/docs/errors/details/_err_ngrok_3200.md +++ b/docs/errors/details/_err_ngrok_3200.md @@ -14,6 +14,6 @@ ngrok is unable to assist with end user content as all content is neither hosted - **Endpoint Domain or Hostname Change** The endpoint domain or hostname has changed. If you are on the Free plan or have not set the `--domain` flag to set the domain on the tunnel, please be aware that the forwarding address will change each time the Agent and session are restarted. If you previously obtained a forwarding URL from an agent session but have since closed that session or closed the client window, the URL will change when a new Agent session starts. - **Typo in Endpoint Address** You have made a typo in the endpoint address you have entered in the browser. Verify that the tunnel hostname is correct. Incorrectly entering the address (a typo) in a browser address bar can also result in this error. - **Network Issues** A network issue exists between the device the Agent is running on and ngrok. Your ngrok agent might have trouble reaching the ngrok service. Try running the [`ngrok diagnose`](/docs/agent/cli/#ngrok-diagnose) command to check for connectivity issues. -- **Incorrect Scheme** You are attempting to run `--scheme http` on your agent using a domain that only supports https. All of the `.app` and `.dev` domains are HSTS or "HTTP Strict Transport Security" domains. Paid plan accounts are able to start http scheme tunnels on the `ngrok.io` domain, which is not HSTS enforced. +- **Incorrect Scheme** You are attempting to run `--url http://...` on your agent using a domain that only supports https. All of the `.app` and `.dev` domains are HSTS or "HTTP Strict Transport Security" domains. Paid plan accounts are able to start http scheme tunnels on the `ngrok.io` domain, which is not HSTS enforced. If you are the Administrator for this ngrok account, and none of these steps work for you or you have additional questions, drop us a note at [support@ngrok.com](mailto:support@ngrok.com?subject=Help%20with%20ngrok%203200%20error). diff --git a/docs/guides/upgrade-v2-v3.mdx b/docs/guides/upgrade-v2-v3.mdx index a0f5bc78f..0ff41aec4 100644 --- a/docs/guides/upgrade-v2-v3.mdx +++ b/docs/guides/upgrade-v2-v3.mdx @@ -18,7 +18,7 @@ ngrok config check This will automatically add `version` and `region` options as well as convert the names of legacy options to their new format. If you're only using ngrok with a configuration file, there's nothing else to do. For more information about the changes to the config file, see the [following section](#upgrading-the-ngrok-agent-config). -**Only HTTPS tunnels by default** - ngrok agent HTTP tunnels by default will only open a single HTTPS endpoint for your upstream service instead of both an HTTP and HTTPS endpoint. To enable both, you will need to add `--scheme http --scheme https` to your ngrok agent command or configuration file. +**Only HTTPS tunnels by default** - ngrok agent HTTP tunnels by default will only open a single HTTPS endpoint for your upstream service instead of both an HTTP and HTTPS endpoint. In order to setup both an HTTP and an HTTPS endpoint, configure multiple endpoints via the configuration file. **Automation using the ngrok agent** - If you have written any scripts or built wrappers around the ngrok agent using command line flags, there are additional changes you will need to make. @@ -26,9 +26,9 @@ This will automatically add `version` and `region` options as well as convert th - The ngrok agent only accepts long name flags prefixed with `--` and will error if a single hyphen is used. When updating your scripts, ensure flags like `--host-header` are using double hyphens. - The following command flags have changed: - `-auth` -> [`--basic-auth`](/agent/cli/#ngrok-http) - - `-bind-tls` -> [`--scheme`](/agent/cli/#ngrok-http) - - `-hostname` -> [`--domain`](/agent/cli/#ngrok-http) - - `-subdomain` -> [`--domain subdomain.ngrok-free.dev`](/agent/cli/#ngrok-http) + - `-bind-tls` -> [`--url`](/agent/cli/#ngrok-http) + - `-hostname` -> [`--url`](/agent/cli/#ngrok-http) + - `-subdomain` -> [`--url subdomain.ngrok-free.dev`](/agent/cli/#ngrok-http) For a full list of changes to the agent for v3, see the [changelog](/agent/changelog). @@ -88,7 +88,7 @@ The latest version of the ngrok agent includes an updated command line argument - The ngrok agent only accepts long name flags prefixed with `--` and will error if a single hyphen is used. When updating your scripts, ensure things like `--hostname` and `--host-header` are using double hyphens. - The following command flags have changed: - `-auth` -> [`--basic-auth`](/agent/cli/#ngrok-http) - - `-bind-tls` -> [`--scheme`](/agent/cli/#ngrok-http) + - `-bind-tls` -> [`--url`](/agent/cli/#ngrok-http) ### Next steps