diff --git a/docs/agent/cli.mdx b/docs/agent/cli.mdx index 5f14e0572..d1964a1fd 100644 --- 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 --domain=bar.ngrok.dev 80 # request subdomain name: 'bar.ngrok.dev' -ngrok http --domain=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 @@ -391,7 +391,7 @@ ngrok http https://localhost:8443 # forward to a local https server | `--circuit-breaker float` | reject requests when 5XX responses exceed this ratio | | `--compression` | gzip compress http responses from your web service | | `--config strings` | path to config files; they are merged if multiple | -| `--domain string` | host tunnel on a custom domain | +| `--url string` | host tunnel on a custom domain | | `-h`, `--help` | help for this command | | `--host-header string` | set Host header; if `rewrite` use local address hostname | | `--inspect` | enable/disable http introspection (default true) | @@ -536,7 +536,7 @@ The `ngrok tls` command starts a TLS tunnel listening for traffic on port 443 wi The ngrok server does not terminate TLS connections forwarded with this command. Any underlying protocol may be used. You may optionally specify a TLS key/cert pair which will be used to terminate the traffic at the ngrok agent before it is forwarded. If not specified, the traffic will be forwarded still encrypted. -Using this command is only recommended with the `--domain` option. Other uses will work, but will always result in certificate mismatch warnings. +Using this command is only recommended with the `--url` option. Other uses will work, but will always result in certificate mismatch warnings. ### Usage @@ -548,7 +548,7 @@ ngrok tls [address:port | port] [flags] ```sh # forward TLS traffic for www.example.com to port 443 (requires CNAME) -ngrok tls --domain=www.example.com 443 +ngrok tls --url=www.example.com 443 ``` ```sh @@ -558,7 +558,7 @@ ngrok tls 1234 ```sh # terminate TLS traffic for t.co before forwarding -ngrok tls --domain=t.co --crt=/path/to/t.co.crt --key=/path/to/t.co.key 443 +ngrok tls --url=t.co --crt=/path/to/t.co.crt --key=/path/to/t.co.key 443 ``` ### Flags @@ -570,7 +570,7 @@ ngrok tls --domain=t.co --crt=/path/to/t.co.crt --key=/path/to/t.co.key 443 | `--cidr-deny strings` | reject connections that match the given CIDRs | | `--config strings` | path to config files; they are merged if multiple | | `--crt string` | path to a TLS certificate for TLS termination | -| `--domain string` | host tunnel on a custom domain | +| `--url string` | host tunnel on a custom domain | | `-h`, `--help` | help for this command | | `--key string` | path to a TLS key for TLS termination | | `--log string` | path to log file, `stdout`, `stderr` or `false` (default `false`) | diff --git a/docs/errors/_err_ngrok_list.md b/docs/errors/_err_ngrok_list.md index f9ae5edc6..539c5aa7a 100644 --- a/docs/errors/_err_ngrok_list.md +++ b/docs/errors/_err_ngrok_list.md @@ -10207,7 +10207,7 @@ ERR_NGROK_15002 - Your account is on the <PLAN> plan, which requires you to register a Domain or TCP Address through the ngrok Dashboard before starting an Endpoint. Visit https://dashboard.ngrok.com/cloud-edge/domains, for HTTP and TLS endpoints, or https://dashboard.ngrok.com/cloud-edge/tcp-addresses, for TCP endpoints, to register a domain or address. Then use the `--domain` flag when starting an HTTP or TLS tunnel with your Agent. For TCP tunnels, use `--remote_addr`. + Your account is on the <PLAN> plan, which requires you to register a Domain or TCP Address through the ngrok Dashboard before starting an Endpoint. Visit https://dashboard.ngrok.com/cloud-edge/domains, for HTTP and TLS endpoints, or https://dashboard.ngrok.com/cloud-edge/tcp-addresses, for TCP endpoints, to register a domain or address. Then use the `--url` flag when starting an HTTP or TLS tunnel with your Agent. For TCP tunnels, use `--remote_addr`. diff --git a/docs/errors/err_ngrok_15002.mdx b/docs/errors/err_ngrok_15002.mdx index 66603eb43..7f5de7991 100644 --- a/docs/errors/err_ngrok_15002.mdx +++ b/docs/errors/err_ngrok_15002.mdx @@ -9,7 +9,7 @@ import ErrorDetails from "/src/components/ErrorDetails"; ### Message -Your account is on the `PLAN` plan, which requires you to register a Domain or TCP Address through the ngrok Dashboard before starting an Endpoint. Visit https://dashboard.ngrok.com/cloud-edge/domains, for HTTP and TLS endpoints, or https://dashboard.ngrok.com/cloud-edge/tcp-addresses, for TCP endpoints, to register a domain or address. Then use the `--domain` flag when starting an HTTP or TLS tunnel with your Agent. For TCP tunnels, use `--remote_addr`. +Your account is on the `PLAN` plan, which requires you to register a Domain or TCP Address through the ngrok Dashboard before starting an Endpoint. Visit https://dashboard.ngrok.com/cloud-edge/domains, for HTTP and TLS endpoints, or https://dashboard.ngrok.com/cloud-edge/tcp-addresses, for TCP endpoints, to register a domain or address. Then use the `--url` flag when starting an HTTP, TLS, or TCP tunnel with your Agent. diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index eb16cfcd0..efce790e4 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -113,11 +113,11 @@ Open the Forwarding URL in your browser and you will see your web application. If you want to keep the same URL each time you use ngrok, [create a static domain on your dashboard](https://dashboard.ngrok.com/cloud-edge/domains) and -then use the `--domain` flag to ask the ngrok agent to use it. First, stop +then use the `--url` flag to ask the ngrok agent to use it. First, stop ngrok with `Ctrl+C` and then run ngrok again: ``` -ngrok http 8080 --domain jumpy-red-mollusk.ngrok-free.app +ngrok http 8080 --url jumpy-red-mollusk.ngrok-free.app ``` ## Step 5: Secure your app @@ -133,7 +133,7 @@ ngrok http http://localhost:8080 --oauth=google --oauth-allow-email=alan@example Anyone accessing your app will be prompted to log in with Google and only your account will be allowed to access it. Keep in mind that when you restart ngrok, -if you don't specify the `--domain` flag that your app's URL changed, so make +if you don't specify the `--url` flag that your app's URL changed, so make sure to visit the new one. diff --git a/docs/guides/getting-started.mdx b/docs/guides/getting-started.mdx index c0bdb3f7e..c021cf386 100644 --- a/docs/guides/getting-started.mdx +++ b/docs/guides/getting-started.mdx @@ -87,11 +87,11 @@ $ ngrok -h EXAMPLES: ngrok http 80 # secure public URL for port 80 web server - ngrok http --domain baz.ngrok.dev 8080 # port 8080 available at baz.ngrok.dev + ngrok http --url baz.ngrok.dev 8080 # port 8080 available at baz.ngrok.dev ngrok http foo.dev:80 # tunnel to host:port instead of localhost ngrok http https://localhost # expose a local https server ngrok tcp 22 # tunnel arbitrary TCP traffic to port 22 - ngrok tls --domain=foo.com 443 # TLS traffic for foo.com to port 443 + ngrok tls --url=foo.com 443 # TLS traffic for foo.com to port 443 ngrok start foo bar baz # start tunnels from the configuration file COMMANDS: @@ -170,7 +170,7 @@ ngrok http 8000 --basic-auth 'ngrok:issecure' Now when you access the new ngrok URL in your browser, you should be prompted for a username and password. -By the way, if you have a paid plan and want to keep the same URL each time you restart, use the [`--domain`](/agent/cli/#ngrok-http) flag when starting the agent. +By the way, if you have a paid plan and want to keep the same URL each time you restart, use the [`--url`](/agent/cli/#ngrok-http) flag when starting the agent. ![](/img/docs/ngrok-basic-auth.png) @@ -196,7 +196,7 @@ Now when you try to visit your new ngrok URL, you will be prompted to log in wit That's it, but there's a lot more you can do with ngrok! -- Configure ngrok to use the same domain each time with [`--domain`](/http/#static-domains) +- Configure ngrok to use the same domain each time with [`--url`](/http/#static-domains) - Tunnel other non-HTTP services such as SSH, RDP, or game servers using [TCP Tunnels](/tcp/) - Bring your own [custom domains to ngrok](/http/#bring-your-own-domain) - Add your [API key and automate via the `ngrok api` command](/agent/cli/#ngrok-api). diff --git a/docs/guides/godaddy.mdx b/docs/guides/godaddy.mdx index ab06adf70..2827458a0 100644 --- a/docs/guides/godaddy.mdx +++ b/docs/guides/godaddy.mdx @@ -37,4 +37,4 @@ For more details, refer to [GoDaddy's guide on adding a CNAME record](https://ww 1. Once you've configured the DNS records in GoDaddy, you can return to the ngrok dashboard and click the "Check Status" button on the bottom of the DNS Details page. It may take a few minutes to an hour for the DNS records to propagate. ngrok will continue to check at a regular interval after your domain is configured. Once you see a green checkmark, you are good to go. -Finally, whenever you want to use your new domain in the ngrok agent, be sure to add `--domain your.domain.com` to the end of any command, such as `ngrok http 80 --domain your.domain.com`. +Finally, whenever you want to use your new domain in the ngrok agent, be sure to add `--url your.domain.com` to the end of any command, such as `ngrok http 80 --url your.domain.com`. diff --git a/docs/guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx b/docs/guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx index fc47b641e..6b6efd981 100644 --- a/docs/guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx +++ b/docs/guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx @@ -51,7 +51,7 @@ Let’s reserve a subdomain on `ngrok.app`: ```bash ngrok api reserved-domains create \ - --domain ${NGROK_SUBDOMAIN}.ngrok.app + --url ${NGROK_SUBDOMAIN}.ngrok.app ``` - Replace or set `NGROK_SUBDOMAIN` as the subdomain you'd like to use for this guide. diff --git a/docs/guides/how-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx b/docs/guides/how-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx index c8df1c5e7..804fce06e 100644 --- a/docs/guides/how-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx +++ b/docs/guides/how-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx @@ -51,7 +51,7 @@ Let’s reserve a subdomain on `ngrok.app`: ```bash ngrok api reserved-domains create \ - --domain ${NGROK_SUBDOMAIN}.ngrok.app + --url ${NGROK_SUBDOMAIN}.ngrok.app ``` - Replace or set `NGROK_SUBDOMAIN` as the subdomain you'd like to use for this guide. diff --git a/docs/guides/how-to-set-up-a-custom-domain.md b/docs/guides/how-to-set-up-a-custom-domain.md index 207838a47..fc2e6f92a 100644 --- a/docs/guides/how-to-set-up-a-custom-domain.md +++ b/docs/guides/how-to-set-up-a-custom-domain.md @@ -57,7 +57,7 @@ Address: 203.0.113.94 Once your DNS record is in place you can create a tunnel using your new domain. Try running: ```bash -ngrok http --domain=foo.example.com 8080 +ngrok http --url=foo.example.com 8080 ``` and presuming you're actually running an application on port 8080 then making an HTTP request to `https://foo.example.com` should return a response from your app. diff --git a/docs/http/basic-auth.mdx b/docs/http/basic-auth.mdx index db18dfbfc..0be735dab 100644 --- a/docs/http/basic-auth.mdx +++ b/docs/http/basic-auth.mdx @@ -144,7 +144,7 @@ This module is available on all plans. Start ngrok in one terminal: ```bash -ngrok http https://httpbin.org --domain your-domain.ngrok.app --basic-auth "falken:joshuahunter2" +ngrok http https://httpbin.org --url your-domain.ngrok.app --basic-auth "falken:joshuahunter2" ``` In another terminal, curl that endpoint. diff --git a/docs/http/compression.mdx b/docs/http/compression.mdx index 91865e46b..30b347913 100644 --- a/docs/http/compression.mdx +++ b/docs/http/compression.mdx @@ -147,7 +147,7 @@ First let's see what this looks like without using compression by running the following in your `test-dir` directory: ```bash -ngrok http file://`pwd` --domain your-domain.ngrok.app +ngrok http file://`pwd` --url your-domain.ngrok.app ``` Then in another terminal while ngrok is still running: @@ -180,7 +180,7 @@ Now let's try it again with compression. Stop your ngrok agent and restart it by changing the command to: ```bash -ngrok http file://`pwd` --domain your-domain.ngrok.app --compression +ngrok http file://`pwd` --url your-domain.ngrok.app --compression ``` Rerun the same curl command: diff --git a/docs/http/index.mdx b/docs/http/index.mdx index 00fdf72c8..4686dce07 100644 --- a/docs/http/index.mdx +++ b/docs/http/index.mdx @@ -634,7 +634,7 @@ ngrok will randomly assign a domain when you create HTTP endpoints unless you specify one. This is okay for one-off uses, but usually you'll want to use a static domain that doesn't change. -You can ask ngrok to always use the same name with the `--domain` option in the +You can ask ngrok to always use the same name with the `--url` option in the agent or an equivalent option with other connectivity choices. **Example**: [Static Domains](#static-domain) diff --git a/docs/http/ip-restrictions.mdx b/docs/http/ip-restrictions.mdx index 1724c69b0..e6d736737 100644 --- a/docs/http/ip-restrictions.mdx +++ b/docs/http/ip-restrictions.mdx @@ -154,7 +154,7 @@ Then run ngrok with IP Restrictions with the IPv4 and IPv6 addresses you got in ```bash ngrok http 80 \ - --domain your-domain.ngrok.app \ + --url your-domain.ngrok.app \ --allow-cidr 2600:8c00::a03c:91ee:fe69:9695/32 \ --allow-cidr 78.227.75.230/32 ``` diff --git a/docs/http/request-headers.mdx b/docs/http/request-headers.mdx index c9e2f7f3d..d47561439 100644 --- a/docs/http/request-headers.mdx +++ b/docs/http/request-headers.mdx @@ -218,7 +218,7 @@ This module is available on all plans. To try out the request headers module we're going to foward to httpbin. ```bash -ngrok http https://httpbin.org --domain your-domain.ngrok.app +ngrok http https://httpbin.org --url your-domain.ngrok.app ``` In another terminal, curl that endpoint: @@ -243,7 +243,7 @@ with `Ctrl+C` and then restart ngrok with a new command. ```bash ngrok http https://httpbin.org \ - --domain your-domain.ngrok.app \ + --url your-domain.ngrok.app \ --request-header-remove='user-agent' \ --request-header-add='country: ${conn.geo.country_code}' ``` diff --git a/docs/http/user-agent-filter.mdx b/docs/http/user-agent-filter.mdx index 4fa17a2c1..f4888cf67 100644 --- a/docs/http/user-agent-filter.mdx +++ b/docs/http/user-agent-filter.mdx @@ -120,7 +120,7 @@ Run ngrok with User Agent Filter's `allow` and `deny` set to the following: ```bash ngrok http 80 \ - --domain your-domain.ngrok.app \ + --url your-domain.ngrok.app \ --ua-filter-allow="(GoingMerry/(\d)+.(\d)+)","(GomuGomu/(\d)+.(\d)+)" \ --ua-filter-deny="(Xebec/(\d)+.(\d)+)" ``` diff --git a/docs/integrations/alchemy/webhooks.mdx b/docs/integrations/alchemy/webhooks.mdx index 7c05d4e56..62982e676 100644 --- a/docs/integrations/alchemy/webhooks.mdx +++ b/docs/integrations/alchemy/webhooks.mdx @@ -159,7 +159,7 @@ This is a quick step to add extra protection to your application. **Note**: After restarting the ngrok agent, the address of the agent will be modified. Because Alchemy doesn't allow you to edit your webhook registration, -it's recommended that you create a domain on your ngrok account, and run the agent using the following parameter `--domain myexample.ngrok.dev` +it's recommended that you create a domain on your ngrok account, and run the agent using the following parameter `--url myexample.ngrok.dev` 1. Access the [Alchemy dashboard](https://dashboard.alchemy.com/) and test the webhook endpoint or create an event by using the Alchemy SDK. diff --git a/docs/integrations/auth0/sso-oidc.mdx b/docs/integrations/auth0/sso-oidc.mdx index 2d930665e..ebc4f8e63 100644 --- a/docs/integrations/auth0/sso-oidc.mdx +++ b/docs/integrations/auth0/sso-oidc.mdx @@ -95,7 +95,7 @@ ngrok can leverage Auth0 SSO in two ways: - Auth0_CLIENT_ID: The client id you copied from Auth0. - Auth0_CLIENT_SECRET: The client secret you copied from Auth0. - Alternatively, add the `--domain YOUR_DOMAIN` argument to get your custom URL, replacing `YOUR_DOMAIN` with your URL of preference. + Alternatively, add the `--url YOUR_DOMAIN` argument to get your custom URL, replacing `YOUR_DOMAIN` with your URL of preference. 1. Copy the URL available next to **Forwarding** (for example, `https://Auth0-sso-test.ngrok.dev`). diff --git a/docs/integrations/curity/sso-oidc.mdx b/docs/integrations/curity/sso-oidc.mdx index 5000dc485..ca12eeb15 100644 --- a/docs/integrations/curity/sso-oidc.mdx +++ b/docs/integrations/curity/sso-oidc.mdx @@ -116,7 +116,7 @@ ngrok can leverage Curity Identity Server in two ways: ngrok http 3000 --oidc= \ --oidc-client-id= \ --oidc-client-secret= \ - --domain=curity-sso-test.ngrok.dev + --url=curity-sso-test.ngrok.dev ``` 1. [Skip to **Step 4**: ](#test-sso) Test the integration diff --git a/docs/integrations/descope/sso-oidc.mdx b/docs/integrations/descope/sso-oidc.mdx index 863459483..74b1fe30a 100644 --- a/docs/integrations/descope/sso-oidc.mdx +++ b/docs/integrations/descope/sso-oidc.mdx @@ -92,7 +92,7 @@ ngrok can leverage Descope SSO in two ways: - `DESCOPE_CLIENT_ID`: This is your Descope Project ID, which can be found under [Project Settings](https://app.descope.com/settings/project). - `DESCOPE_CLIENT_SECRET`: The is the Descope Access Key that you created from earlier. - Alternatively, add the `--domain YOUR_DOMAIN` argument to get your custom URL, replacing `YOUR_DOMAIN` with your URL of preference. + Alternatively, add the `--url YOUR_DOMAIN` argument to get your custom URL, replacing `YOUR_DOMAIN` with your URL of preference. 1. Copy the URL available next to **Forwarding** (for example, `https://descope-sso-test.ngrok.dev`). diff --git a/docs/integrations/facebook-messenger/webhooks.mdx b/docs/integrations/facebook-messenger/webhooks.mdx index 22b8be0dd..c33567132 100644 --- a/docs/integrations/facebook-messenger/webhooks.mdx +++ b/docs/integrations/facebook-messenger/webhooks.mdx @@ -9,7 +9,7 @@ description: Develop and test Facebook Messenger webhooks from localhost To integrate Facebook Messenger webhooks with ngrok: 1. [Launch your local webhook.](#start-your-app) `node appFB` -1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --domain myexample.ngrok.dev` +1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --url myexample.ngrok.dev` 1. [Configure Facebook webhooks with your ngrok URL.](#setup-webhook) 1. [Secure your webhook requests with verification.](#security) @@ -76,7 +76,7 @@ Once your app is running successfully on localhost, let's get it on the internet 1. Start ngrok by running the following command in a terminal on your local desktop: ```bash - ngrok http 3000 --domain myexample.ngrok.dev + ngrok http 3000 --url myexample.ngrok.dev ``` 1. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with Facebook). @@ -191,7 +191,7 @@ This is a quick step to add extra protection to your application. 1. Restart your ngrok agent by running the command, replacing `{your app secret}` with the value you have copied before: ```bash - ngrok http 3000 --domain myexample.ngrok.dev --verify-webhook facebook_messenger --verify-webhook-secret {your app secret} + ngrok http 3000 --url myexample.ngrok.dev --verify-webhook facebook_messenger --verify-webhook-secret {your app secret} ``` 1. Access the Facebook page you have assigned to your webhook and send a message to another Facebook user. diff --git a/docs/integrations/facebook/webhooks.mdx b/docs/integrations/facebook/webhooks.mdx index c9eba9089..6ac2cdead 100644 --- a/docs/integrations/facebook/webhooks.mdx +++ b/docs/integrations/facebook/webhooks.mdx @@ -9,7 +9,7 @@ description: Develop and test Facebook webhooks from localhost To integrate Facebook webhooks with ngrok: 1. [Launch your local webhook.](#start-your-app) `npm run startFacebook` -1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --domain myexample.ngrok.dev` +1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --url myexample.ngrok.dev` 1. [Configure Facebook webhooks with your ngrok URL.](#setup-webhook) 1. [Secure your webhook requests with verification.](#security) @@ -76,7 +76,7 @@ Once your app is running successfully on localhost, let's get it on the internet 1. Start ngrok by running the following command in a terminal on your local desktop: ```bash - ngrok http 3000 --domain myexample.ngrok.dev + ngrok http 3000 --url myexample.ngrok.dev ``` 1. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with Facebook). @@ -169,7 +169,7 @@ This is a quick step to add extra protection to your application. 1. Restart your ngrok agent by running the command, replacing `{your app secret}` with the value you have copied before: ```bash - ngrok http 3000 --domain myexample.ngrok.dev --verify-webhook facebook_graph_api --verify-webhook-secret {your app secret} + ngrok http 3000 --url myexample.ngrok.dev --verify-webhook facebook_graph_api --verify-webhook-secret {your app secret} ``` 1. Access the Facebook page you have assigned to your webhook and send a message to another Facebook user. diff --git a/docs/integrations/frontegg/sso-oidc.md b/docs/integrations/frontegg/sso-oidc.md index 962168d3b..bd4318133 100644 --- a/docs/integrations/frontegg/sso-oidc.md +++ b/docs/integrations/frontegg/sso-oidc.md @@ -96,7 +96,7 @@ ngrok can leverage Frontegg SSO in two ways: - FRONTEGG_CLIENT_ID: The client id you copied from Frontegg. - FRONTEGG_CLIENT_SECRET: The API key you copied from Frontegg. - Alternatively, add the `--domain YOUR_DOMAIN` argument to get your custom URL, replacing `YOUR_DOMAIN` with your URL of preference. + Alternatively, add the `--url YOUR_DOMAIN` argument to get your custom URL, replacing `YOUR_DOMAIN` with your URL of preference. 1. Copy the URL available next to **Forwarding** (for example, `https://frontegg-sso-test.ngrok.app`). diff --git a/docs/integrations/fusionauth/sso-oidc.mdx b/docs/integrations/fusionauth/sso-oidc.mdx index 9a7cb1065..dd6e174be 100644 --- a/docs/integrations/fusionauth/sso-oidc.mdx +++ b/docs/integrations/fusionauth/sso-oidc.mdx @@ -73,7 +73,7 @@ ngrok can leverage FusionAuth SSO in two ways: ngrok http 3000 --oidc= \ --oidc-client-id= \ --oidc-client-secret= \ - --domain=fusionauth-sso-test.ngrok.dev + --url=fusionauth-sso-test.ngrok.dev ``` 1. Skip to **Step 3** diff --git a/docs/integrations/instagram/webhooks.mdx b/docs/integrations/instagram/webhooks.mdx index 49bcef588..a737948b7 100644 --- a/docs/integrations/instagram/webhooks.mdx +++ b/docs/integrations/instagram/webhooks.mdx @@ -9,7 +9,7 @@ description: Develop and test Instagram webhooks from localhost To integrate Instagram webhooks with ngrok: 1. [Launch your local webhook.](#start-your-app) `npm run startFacebook` -1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --domain myexample.ngrok.dev` +1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --url myexample.ngrok.dev` 1. [Configure Instagram webhooks with your ngrok URL.](#setup-webhook) 1. [Secure your webhook requests with verification.](#security) @@ -76,7 +76,7 @@ Once your app is running successfully on localhost, let's get it on the internet 1. Start ngrok by running the following command in a terminal on your local desktop: ```bash - ngrok http 3000 --domain myexample.ngrok.dev + ngrok http 3000 --url myexample.ngrok.dev ``` 1. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with Facebook). @@ -177,7 +177,7 @@ This is a quick step to add extra protection to your application. 1. Restart your ngrok agent by running the command, replacing `{your app secret}` with the value you have copied before: ```bash - ngrok http 3000 --domain myexample.ngrok.dev --verify-webhook FACEBOOK_GRAPH_API --verify-webhook-secret {your app secret} + ngrok http 3000 --url myexample.ngrok.dev --verify-webhook FACEBOOK_GRAPH_API --verify-webhook-secret {your app secret} ``` 1. Access the Instagram page you have assigned to your webhook and send a message to another Instagram user. diff --git a/docs/integrations/jumpcloud/sso-oidc.mdx b/docs/integrations/jumpcloud/sso-oidc.mdx index cca835932..40ed6a4a0 100644 --- a/docs/integrations/jumpcloud/sso-oidc.mdx +++ b/docs/integrations/jumpcloud/sso-oidc.mdx @@ -95,7 +95,7 @@ ngrok can leverage JumpCloud SSO in two ways: - JUMPCLOUD_CLIENT_ID: The client id you copied from JumpCloud. - JUMPCLOUD_CLIENT_SECRET: The client secret you copied from JumpCloud. - Alternatively, add the `--domain YOUR_DOMAIN` argument to get your custom URL, replacing `YOUR_DOMAIN` with your URL of preference. + Alternatively, add the `--url YOUR_DOMAIN` argument to get your custom URL, replacing `YOUR_DOMAIN` with your URL of preference. 1. Copy the URL available next to **Forwarding** (for example, `https://jumpcloud-sso-test.ngrok.dev`). diff --git a/docs/integrations/miniorange/sso-oidc.mdx b/docs/integrations/miniorange/sso-oidc.mdx index 5805369e1..3aa8ca85c 100644 --- a/docs/integrations/miniorange/sso-oidc.mdx +++ b/docs/integrations/miniorange/sso-oidc.mdx @@ -95,7 +95,7 @@ ngrok can leverage miniOrange SSO in two ways: - MINIORANGE_CLIENT_ID: The client id you copied from miniOrange. - MINIORANGE_CLIENT_SECRET: The client secret you copied from miniOrange. - Alternatively, add the `--domain YOUR_DOMAIN` argument to get your a custom URL, replacing `YOUR_DOMAIN` with your URL of preference. + Alternatively, add the `--url YOUR_DOMAIN` argument to get your a custom URL, replacing `YOUR_DOMAIN` with your URL of preference. 1. Copy the URL available next to **Forwarding** (for example, `https://miniOrange-sso-test.ngrok.io`). diff --git a/docs/integrations/okta/sso-oidc.mdx b/docs/integrations/okta/sso-oidc.mdx index b8ae8b0a2..db4972cd6 100644 --- a/docs/integrations/okta/sso-oidc.mdx +++ b/docs/integrations/okta/sso-oidc.mdx @@ -77,13 +77,13 @@ ngrok can leverage Okta SSO in two ways: > **Note:** For this tutorial, we assume you have an app running locally (i.e., on localhost:3000) with the ngrok client installed. 1. Launch a terminal -1. Enter the following command to launch an ngrok tunnel with Okta SSO. Replace `` with your okta org address (i.e., https://acme.okta.com) and the `` and `` with the respective values copied from the ngrok app registered at Okta. Optionally, add the `--domain ` argument to get your own custom URL, replacing `` with your URL of preference: +1. Enter the following command to launch an ngrok tunnel with Okta SSO. Replace `` with your okta org address (i.e., https://acme.okta.com) and the `` and `` with the respective values copied from the ngrok app registered at Okta. Optionally, add the `--url ` argument to get your own custom URL, replacing `` with your URL of preference: ```bash ngrok http 3000 --oidc= \ --oidc-client-id= \ --oidc-client-secret= \ - --domain= + --url= ``` 1. Copy the url available next to **Forwarding** (for example, `https://okta-sso-test.ngrok.dev`). diff --git a/docs/integrations/teams/webhooks.mdx b/docs/integrations/teams/webhooks.mdx index 77477d591..241a89dce 100644 --- a/docs/integrations/teams/webhooks.mdx +++ b/docs/integrations/teams/webhooks.mdx @@ -5,7 +5,7 @@ To integrate Microsoft Teams webhooks with ngrok: 1. [Launch your local webhook.](#start-your-app) `npm start` -1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --domain myexample.ngrok.dev` +1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --url myexample.ngrok.dev` 1. [Configure Microsoft Teams webhooks with your ngrok URL.](#setup-webhook) 1. [Secure your webhook requests with verification.](#security) @@ -72,7 +72,7 @@ Once your app is running successfully on localhost, let's get it on the internet 1. Start ngrok by running the following command in a terminal on your local desktop: ```bash - ngrok http 3000 --domain myexample.ngrok.dev + ngrok http 3000 --url myexample.ngrok.dev ``` 1. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with Microsoft Teams). @@ -151,7 +151,7 @@ This is a quick step to add extra protection to your application. 1. Restart your ngrok agent by running the command, replacing `{your app secret}` with the **Security token** value you copied before (See [Integrate Microsoft Teams](#setup-webhook)): ```bash - ngrok http 3000 --domain myexample.ngrok.dev --verify-webhook microsoft_teams --verify-webhook-secret {your app secret} + ngrok http 3000 --url myexample.ngrok.dev --verify-webhook microsoft_teams --verify-webhook-secret {your app secret} ``` 1. Access the Microsoft Teams page you have assigned to your webhook and send a message to another Microsoft Teams user. diff --git a/docs/integrations/trustelem/sso-oidc.mdx b/docs/integrations/trustelem/sso-oidc.mdx index f6bc07e89..04a45d13d 100644 --- a/docs/integrations/trustelem/sso-oidc.mdx +++ b/docs/integrations/trustelem/sso-oidc.mdx @@ -81,7 +81,7 @@ ngrok can leverage Wallix Trustelem SSO in two ways: - Trustelem_CLIENT_ID: The client id you copied from the Trustelem console. - Trustelem_CLIENT_SECRET: The client secret you copied from the Trustelem console. - Alternatively, add the `--domain YOUR_DOMAIN` argument to get your a custom URL, replacing `YOUR_DOMAIN` with your URL of preference. + Alternatively, add the `--url YOUR_DOMAIN` argument to get your a custom URL, replacing `YOUR_DOMAIN` with your URL of preference. 1. Copy the URL available next to **Forwarding** (for example, `https://trustelem-sso-test.ngrok.io`). diff --git a/docs/integrations/whatsapp/webhooks.mdx b/docs/integrations/whatsapp/webhooks.mdx index 36684b15b..4f260b5ea 100644 --- a/docs/integrations/whatsapp/webhooks.mdx +++ b/docs/integrations/whatsapp/webhooks.mdx @@ -9,7 +9,7 @@ description: Develop and test WhatsApp webhooks from localhost To integrate WhatsApp webhooks with ngrok: 1. [Launch your local webhook.](#start-your-app) `npm run startFacebook` -1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --domain myexample.ngrok.dev` +1. [Launch ngrok.](#start-ngrok) `ngrok http 3000 --url myexample.ngrok.dev` 1. [Configure WhatsApp webhooks with your ngrok URL.](#setup-webhook) 1. [Secure your webhook requests with verification.](#security) @@ -76,7 +76,7 @@ Once your app is running successfully on localhost, let's get it on the internet 1. Start ngrok by running the following command in a terminal on your local desktop: ```bash - ngrok http 3000 --domain myexample.ngrok.dev + ngrok http 3000 --url myexample.ngrok.dev ``` 1. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with Facebook). @@ -173,7 +173,7 @@ This is a quick step to add extra protection to your application. 1. Restart your ngrok agent by running the command, replacing `{your app secret}` with the value you have copied before: ```bash - ngrok http 3000 --domain myexample.ngrok.dev --verify-webhook FACEBOOK_GRAPH_API --verify-webhook-secret {your app secret} + ngrok http 3000 --url myexample.ngrok.dev --verify-webhook FACEBOOK_GRAPH_API --verify-webhook-secret {your app secret} ``` 1. Access the WhatsApp page you have assigned to your webhook and send a message to another WhatsApp user. diff --git a/docs/network-edge/domains-and-tcp-addresses.mdx b/docs/network-edge/domains-and-tcp-addresses.mdx index 4dac930b2..ce5185548 100644 --- a/docs/network-edge/domains-and-tcp-addresses.mdx +++ b/docs/network-edge/domains-and-tcp-addresses.mdx @@ -77,7 +77,7 @@ For example: ###### Listen for all subdomains of `example.com` ```bash -ngrok http 80 --domain *.example.com +ngrok http 80 --url *.example.com ``` The following rules define the behavior of endpoints on wildcard domains. To @@ -87,7 +87,7 @@ illustrate the rules, assume you have created the wildcard domain - Connections to nested subdomains (e.g. `foo.bar.baz.example.com`) will route to a wildcard endpoint of `*.example.com`. - You may create endpoints on any valid subdomain of `example.com` without - creating an additional Domain object. For example, `ngrok 80 http --domain + creating an additional Domain object. For example, `ngrok 80 http --url foo.bar.baz.example.com` works without creating a domain for `foo.bar.baz.example.com`. - Connections are routed to the most specific online endpoint. If there are diff --git a/docs/tls/ip-restrictions.mdx b/docs/tls/ip-restrictions.mdx index 2a20c1f9f..982d6cb31 100644 --- a/docs/tls/ip-restrictions.mdx +++ b/docs/tls/ip-restrictions.mdx @@ -137,7 +137,7 @@ Then run ngrok with IP Restrictions with the IPv4 and IPv6 addresses you got in ```bash ngrok tls 443 \ - --domain your-domain.ngrok.app \ + --url your-domain.ngrok.app \ --allow-cidr 2600:8c00::a03c:91ee:fe69:9695/32 \ --allow-cidr 78.227.75.230/32 ``` diff --git a/docs/using-ngrok-with/docker.md b/docs/using-ngrok-with/docker.md index 78ee19830..3e6c5981e 100644 --- a/docs/using-ngrok-with/docker.md +++ b/docs/using-ngrok-with/docker.md @@ -14,11 +14,11 @@ Note: the Docker version of ngrok follows the same convention as the agent, for ```bash docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest http 80 # secure public URL for port 80 web server -docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest http --domain=baz.ngrok.dev 8080 # port 8080 available at baz.ngrok.dev +docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest http --url=baz.ngrok.dev 8080 # port 8080 available at baz.ngrok.dev docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest http foo.dev:80 # tunnel to host:port instead of localhost docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest http https://localhost:5001 # expose a local https server running on port 5001 docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest tcp 22 # tunnel arbitrary TCP traffic to port 22 -docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest tls --domain=foo.com 443 # TLS traffic for foo.com to port 443 +docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest tls --url=foo.com 443 # TLS traffic for foo.com to port 443 docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest start foo bar baz # start tunnels from the configuration file ``` diff --git a/docs/using-ngrok-with/wordpress.md b/docs/using-ngrok-with/wordpress.md index fe0159c90..f16af621c 100644 --- a/docs/using-ngrok-with/wordpress.md +++ b/docs/using-ngrok-with/wordpress.md @@ -13,7 +13,7 @@ To make ngrok work properly with Wordpress installations you usually need to do 1. You must instruct ngrok to [rewrite the host header](/http/#rewrite-host-header) and point to the port of your Wordpress install (usually port 80), like so: ```bash - ngrok http 80 --host-header=rewrite --domain www.your-site.dev + ngrok http 80 --host-header=rewrite --url www.your-site.dev ``` 1. You must ensure that Wordpress understands that it is meant to serve itself from your tunneled hostname. You can configure Wordpress to do that by modifying your [`wp-config`](https://developer.wordpress.org/advanced-administration/wordpress/wp-config/) to include the following lines where `www.your-site.dev` is replaced with the URL from ngrok: diff --git a/examples/agent-cli/http-branded-domain.mdx b/examples/agent-cli/http-branded-domain.mdx index 54d93c261..ae9959a8d 100644 --- a/examples/agent-cli/http-branded-domain.mdx +++ b/examples/agent-cli/http-branded-domain.mdx @@ -1,3 +1,3 @@ ```bash -ngrok http 80 --domain app.example.com +ngrok http 80 --url app.example.com ``` diff --git a/examples/agent-cli/http-static-domain.mdx b/examples/agent-cli/http-static-domain.mdx index 591e3dbf3..fe96559fa 100644 --- a/examples/agent-cli/http-static-domain.mdx +++ b/examples/agent-cli/http-static-domain.mdx @@ -1,3 +1,3 @@ ```bash -ngrok http 80 --domain example.ngrok.app +ngrok http 80 --url example.ngrok.app ``` diff --git a/examples/agent-cli/http-wildcard-domain.mdx b/examples/agent-cli/http-wildcard-domain.mdx index 403701050..49c99bc5e 100644 --- a/examples/agent-cli/http-wildcard-domain.mdx +++ b/examples/agent-cli/http-wildcard-domain.mdx @@ -1,3 +1,3 @@ ```bash -ngrok http 80 --domain *.example.com +ngrok http 80 --url *.example.com ``` diff --git a/examples/agent-cli/ipv6.mdx b/examples/agent-cli/ipv6.mdx index 2963ad5aa..0e53c7ec1 100644 --- a/examples/agent-cli/ipv6.mdx +++ b/examples/agent-cli/ipv6.mdx @@ -1,7 +1,7 @@ ```bash -ngrok http '[::1]:80' --domain ipv6.example.com +ngrok http '[::1]:80' --url ipv6.example.com ``` ```bash -ngrok http 'https://[2001:db8::123.123.123.123]:8443' --domain ipv6.example.com +ngrok http 'https://[2001:db8::123.123.123.123]:8443' --url ipv6.example.com ``` diff --git a/examples/agent-cli/tls-mtls-at-agent.mdx b/examples/agent-cli/tls-mtls-at-agent.mdx index b2e7c6e59..76edeac9b 100644 --- a/examples/agent-cli/tls-mtls-at-agent.mdx +++ b/examples/agent-cli/tls-mtls-at-agent.mdx @@ -1,6 +1,6 @@ ```bash ngrok tls 80 \ - --domain app.example.com \ + --url app.example.com \ --terminate-at agent \ --crt /path/to/app-example-com-crt.pem \ --key /path/to/app-example-com-crt.key \ diff --git a/examples/agent-cli/tls-mtls-at-edge.mdx b/examples/agent-cli/tls-mtls-at-edge.mdx index a0f9ad88b..7ca2f971e 100644 --- a/examples/agent-cli/tls-mtls-at-edge.mdx +++ b/examples/agent-cli/tls-mtls-at-edge.mdx @@ -1,6 +1,6 @@ ```bash ngrok tls 80 \ - --domain app.example.com \ + --url app.example.com \ --terminate-at edge \ --mutual-tls-cas /path/to/cas.pem ``` diff --git a/examples/agent-cli/tls-terminate-at-agent.mdx b/examples/agent-cli/tls-terminate-at-agent.mdx index f454b70ff..88db5998c 100644 --- a/examples/agent-cli/tls-terminate-at-agent.mdx +++ b/examples/agent-cli/tls-terminate-at-agent.mdx @@ -1,7 +1,7 @@ ```bash ngrok tls 80 \ --terminate-at agent \ - --domain app.example.com \ + --url app.example.com \ --crt /path/to/app-example-com-crt.pem \ --key /path/to/app-example-com-key.pem ``` diff --git a/examples/agent-cli/tls-terminate-at-edge-custom-cert.mdx b/examples/agent-cli/tls-terminate-at-edge-custom-cert.mdx index 3fb774c0f..305ff1da0 100644 --- a/examples/agent-cli/tls-terminate-at-edge-custom-cert.mdx +++ b/examples/agent-cli/tls-terminate-at-edge-custom-cert.mdx @@ -1,6 +1,6 @@ ```bash ngrok tls 80 - --domain your-name.ngrok.app \ + --url your-name.ngrok.app \ --terminate-at edge \ --crt /path/to/app-example-com-crt.pem \ --key /path/to/app-example-com-key.pem diff --git a/examples/agent-cli/tls-terminate-at-edge-custom-domain.mdx b/examples/agent-cli/tls-terminate-at-edge-custom-domain.mdx index 99db3fe9f..093f123bf 100644 --- a/examples/agent-cli/tls-terminate-at-edge-custom-domain.mdx +++ b/examples/agent-cli/tls-terminate-at-edge-custom-domain.mdx @@ -1,3 +1,3 @@ ```bash -ngrok tls 80 --terminate-at edge --domain your-name.ngrok.app +ngrok tls 80 --terminate-at edge --url your-name.ngrok.app ``` diff --git a/examples/agent-cli/tls-terminate-at-upstream.mdx b/examples/agent-cli/tls-terminate-at-upstream.mdx index 6a92ec192..a7d8a2d17 100644 --- a/examples/agent-cli/tls-terminate-at-upstream.mdx +++ b/examples/agent-cli/tls-terminate-at-upstream.mdx @@ -1,5 +1,5 @@ ```bash ngrok tls 443 \ --terminate-at upstream \ - --domain app.example.com + --url app.example.com ```