From 6d42f40f4bf946c1f727466ee79795f803d4ce9c Mon Sep 17 00:00:00 2001 From: Joel Hans Date: Wed, 25 Sep 2024 09:24:26 -0700 Subject: [PATCH] Fix broken links in new guides re-org (#952) This is based on @DevMandy's #945 PR and should only be merged with her approval. We can either merge this into #945 and then merge them into `main` together, or I can change this PR to point to `main` after #945 is merged. --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> --- docs/agent/changelog.md | 4 ++-- docs/guides/index.md | 2 +- ...-load-balancing-with-ngrok-cloud-edges.mdx | 2 +- docs/guides/other-guides/index.mdx | 24 +++++++++---------- .../load-balancing-with-cloud-edges.md | 2 +- .../other-guides/using-labels-within-ngrok.md | 2 +- .../guides/site-to-site-connectivity/apis.mdx | 2 +- docs/guides/site-to-site-connectivity/dbs.mdx | 2 +- docs/http/request-headers.mdx | 5 ++-- docs/k8s/advanced-deployments.mdx | 2 +- docs/using-ngrok-with/mysql.md | 5 ++-- docs/using-ngrok-with/rtmp.md | 2 +- docs/whats-new.mdx | 3 ++- 13 files changed, 30 insertions(+), 27 deletions(-) diff --git a/docs/agent/changelog.md b/docs/agent/changelog.md index b28636c0b..2d0fcbcd6 100644 --- a/docs/agent/changelog.md +++ b/docs/agent/changelog.md @@ -133,7 +133,7 @@ title: Changelog ### ngrok Agent 3.3.0 - \[2023-05-09\] -- Added new default tunnel ingress names: the agent now connects to [`connect.ngrok-agent.com`](/guides/security-dev-productivity/#6-track-and-block-unauthorized-tunnel-activity) when starting a session +- Added new default tunnel ingress names: the agent now connects to [`connect.ngrok-agent.com`](/guides/other-guides/security-dev-productivity/security-dev-productivity.md#6-track-and-block-unauthorized-tunnel-activity) when starting a session - Improved `ngrok diagnose` output to check that the DNS entry for `localhost` resolves - Added the command `ngrok config add-server-addr` for configuring custom agent ingresses - Re-wrote the tunnel and session backend to use the `ngrok-go` library @@ -202,7 +202,7 @@ title: Changelog ### ngrok Agent 3.0.0 - \[2022-03-28\] -For more information about upgrading from previous versions of the agent to v3.0, see our [upgrade guide](/guides/upgrade-v2-v3). +For more information about upgrading from previous versions of the agent to v3.0, see our [upgrade guide](/guides/other-guides/upgrade-v2-v3.mdx). - Fixed an issue where an agent would not reconnect after removing a reserved domain from your account. - Added `ngrok completion` to enable autocomplete for the cli. diff --git a/docs/guides/index.md b/docs/guides/index.md index 5209e2af7..de721d214 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -32,7 +32,7 @@ Here you will find a set of guides to help you with common (and not so common) t | [Secure Developer Productivity](other-guides/security-dev-productivity) | Learn best security practices for securing your ngrok account and enhance developer productivity | | [Securing ngrok](other-guides/securing-your-tunnels.md) | Explore best practices for securing your ngrok tunnels | | [Corporate Firewall](other-guides/running-behind-firewalls.md) | Run ngrok behind your corporate firewall | -| [Using Mutual TLS (mTLS) Authentication](other-guides/using-mtls-authentication.mdx) | Enable mTLS on your ngrok endpoints | +| [Using Mutual TLS (mTLS) Authentication](other-guides/using-tls-mutual-authentication.md) | Enable mTLS on your ngrok endpoints | | [Configure Okta Single Sign-On (SSO)](other-guides/dashboard-sso-okta-setup.md) | Add SSO via Okta to your ngrok account | | [Load Balancing with ngrok Cloud Edges](other-guides/load-balancing-with-cloud-edges.md) | Load balance with ngrok cloud Edges | | [Round Robin Load Balancing](other-guides/how-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx) | Round robin load balance with ngrok cloud Edges | diff --git a/docs/guides/other-guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx b/docs/guides/other-guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx index b990af2b8..0c6e0f3ae 100644 --- a/docs/guides/other-guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx +++ b/docs/guides/other-guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx @@ -22,7 +22,7 @@ import Tabs from "@theme/Tabs"; The purpose of **Load balancing** is to improve application performance and reduce burden by distributing incoming traffic across servers. This leads to faster response times for user-facing applications. -**Weighted Round-robin load balancing** while similar to [round-robin load balancing](how-to-round-robin-load-balance-with-ngrok-cloud-edges) +**Weighted Round-robin load balancing** while similar to [round-robin load balancing](how-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx) here you can assign a numeric weight to all of the applications behind the load balancer. Weights can be assigned based on factors such as the application state, server’s processing power or total bandwidth. diff --git a/docs/guides/other-guides/index.mdx b/docs/guides/other-guides/index.mdx index cdd1c4803..47e6c94f3 100644 --- a/docs/guides/other-guides/index.mdx +++ b/docs/guides/other-guides/index.mdx @@ -8,15 +8,15 @@ title: Other Guides This section provides additional guides for using ngrok. | Name | Description | |-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| [Free Plan Limits](other-guides/limits.md) | Learn about the resources available on our free seat-based plan | -| [Licensing](other-guides/licensing.md) | Explore frequently asked questions about ngrok licensing and plan limits | -| [Upgrading to Agent v3](other-guides/upgrade-v2-v3.md) | Learn about new features and breaking changes when upgrading from ngrok Agent v2 to v3 | -| [Secure Developer Productivity](other-guides/security-dev-productivity) | Learn best security practices securing your ngrok account to enhance developer productivity | -| [Securing ngrok](other-guides/securing-your-tunnels.md) | Explore best practices for securing your ngrok tunnels | -| [Corporate Firewall](other-guides/running-behind-firewalls.md) | Run ngrok behing your corporate firewall | -| [Using Mutual TLS (mTLS) Authentication](other-guides/using-mtls-authentication.md) | Quick Start guide for enabling mTLS on your ngrok endpoints | -| [Configure Okta Single Sign-On (SSO)](other-guides/dashboard-sso-okta-setup.md) | Add SSO via Okta to your ngrok account | -| [Load Balancing with ngrok Cloud Edges](other-guides/load-balancing-with-cloud-edges.md) | Configure load balancing with ngrok cloud Edges | -| [Round Robin Load Balancing](other-guides/hot-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx) | Configure round robin load balancing with ngrok cloud Edges | -| [Weighted Round Robin Load Balancing](other-guides/how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.md) | Configure weighted load balancing with ngrok cloud Edges | -| [Using Labels with ngrok](other-guides/using-labels-within-ngrok.md) | Learn how to ngrok Labels | +| [Free Plan Limits](limits.md) | Learn about the resources available on our free seat-based plan | +| [Licensing](licensing.md) | Explore frequently asked questions about ngrok licensing and plan limits | +| [Upgrading to Agent v3](upgrade-v2-v3.mdx) | Learn about new features and breaking changes when upgrading from ngrok Agent v2 to v3 | +| [Secure Developer Productivity](security-dev-productivity/security-dev-productivity.md) | Learn best security practices securing your ngrok account to enhance developer productivity | +| [Securing ngrok](securing-your-tunnels.md) | Explore best practices for securing your ngrok tunnels | +| [Corporate Firewall](running-behind-firewalls.md) | Run ngrok behing your corporate firewall | +| [Using Mutual TLS (mTLS) Authentication](using-tls-mutual-authentication.md) | Quick Start guide for enabling mTLS on your ngrok endpoints | +| [Configure Okta Single Sign-On (SSO)](dashboard-sso-okta-setup.md) | Add SSO via Okta to your ngrok account | +| [Load Balancing with ngrok Cloud Edges](load-balancing-with-cloud-edges.md) | Configure load balancing with ngrok cloud Edges | +| [Round Robin Load Balancing](how-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx) | Configure round robin load balancing with ngrok cloud Edges | +| [Weighted Round Robin Load Balancing](how-to-do-weighted-load-balancing-with-ngrok-cloud-edges.mdx) | Configure weighted load balancing with ngrok cloud Edges | +| [Using Labels with ngrok](using-labels-within-ngrok.md) | Learn how to ngrok Labels | diff --git a/docs/guides/other-guides/load-balancing-with-cloud-edges.md b/docs/guides/other-guides/load-balancing-with-cloud-edges.md index b2e16fac5..37c750207 100644 --- a/docs/guides/other-guides/load-balancing-with-cloud-edges.md +++ b/docs/guides/other-guides/load-balancing-with-cloud-edges.md @@ -41,4 +41,4 @@ That's all there is to it. You now have multiple ngrok agents load balancing tra - [HTTPS Edges](/http/#edges) - [HTTPS Edge Routes](/http/#routes) - [HTTPS Edge Modules](/http/#modules) -- [Securing your ngrok Tunnels](/guides/securing-your-tunnels) +- [Securing your ngrok Tunnels](/guides/other-guides/securing-your-tunnels) diff --git a/docs/guides/other-guides/using-labels-within-ngrok.md b/docs/guides/other-guides/using-labels-within-ngrok.md index 574892e8d..2474fec93 100644 --- a/docs/guides/other-guides/using-labels-within-ngrok.md +++ b/docs/guides/other-guides/using-labels-within-ngrok.md @@ -14,7 +14,7 @@ When using the ngrok agent, or any one of our agent SDKs, the way to get include This guide will discuss the usage of labels and provide considerations for deterministically defining the tunnel group membership as your Cloud Edge deployment grows and some best practices to consider. -Reference the [following article](/docs/guides/how-to-round-robin-load-balance-with-ngrok-cloud-edges/) for an example on configuring edges and backends. +Reference the [following article](/docs/guides/other-guides/how-to-round-robin-load-balance-with-ngrok-cloud-edges.mdx) for an example on configuring edges and backends. ## Label Usage diff --git a/docs/guides/site-to-site-connectivity/apis.mdx b/docs/guides/site-to-site-connectivity/apis.mdx index 5276c74fa..f308f22a5 100644 --- a/docs/guides/site-to-site-connectivity/apis.mdx +++ b/docs/guides/site-to-site-connectivity/apis.mdx @@ -11,7 +11,7 @@ This guide provides step-by-step instructions for using ngrok for site-to-site c This example shows you how to run the ngrok agent at an external site to get access to locally running APIs. -The connection will be unencrypted. ngrok recommends [configuring end-to-end encryption with mTLS](/guides/site-to-site-apis-mtls/). +The connection will be unencrypted. ngrok recommends [configuring end-to-end encryption with mTLS](apis-mtls.mdx). However, we understand there are times when you may wish to configure an unencrypted connection such as during testing or proof of concept. Therefore, we provide the steps in this guide, but we recommend configuring mTLS before going to production. diff --git a/docs/guides/site-to-site-connectivity/dbs.mdx b/docs/guides/site-to-site-connectivity/dbs.mdx index f5040ae6e..8c96532c2 100644 --- a/docs/guides/site-to-site-connectivity/dbs.mdx +++ b/docs/guides/site-to-site-connectivity/dbs.mdx @@ -11,7 +11,7 @@ This guide provides step-by-step instructions for using ngrok for site-to-site c This example shows you how to run the ngrok agent at an external site to get access to a locally running database. -The connection will be unencrypted. ngrok recommends [configuring end-to-end encryption with mTLS](/guides/site-to-site-dbs-mtls). . +The connection will be unencrypted. ngrok recommends [configuring end-to-end encryption with mTLS](dbs-mtls.mdx). However, we understand there are times when you may wish to configure an unencrypted connection such as during testing or proof of concept. Therefore, we provide the steps in this guide, but we recommend configuring mTLS before going to production. diff --git a/docs/http/request-headers.mdx b/docs/http/request-headers.mdx index d47561439..8b728111c 100644 --- a/docs/http/request-headers.mdx +++ b/docs/http/request-headers.mdx @@ -75,7 +75,7 @@ Consult the [Variables Reference](#variables) for the available variables. ### Automatic Headers {#automatic-headers} -Regardless of whether you enable the request headers module or not, [ngrok adds +Regardless of whether you enable the request headers module or not,other-guides/ [ngrok adds default headers to every HTTP request](/http/#upstream-headers). You may remove these default headers with the request headers module. For example: @@ -174,7 +174,8 @@ transmitted to the upstream service. - You may not add or remove the `user-agent` header. - You may not remove the `host` header without adding it with a different value. - Adding a `host` header will replace the existing value instead of adding a second value. -- You may not use this module to add the `ngrok-skip-browser-warning` header to skip the ngrok browser warning on free accounts. For more information about the abuse interstitial, please check out the [free plan limits guide](/docs/guides/limits/#why-is-there-an-interstitial-in-front-of-my-html-content). +- You may not use this module to add the `ngrok-skip-browser-warning` header to + skip the ngrok browser warning on free accounts. For more information about the abuse interstitial, please check out the [free plan limits guide](/docs/guides/other-guides/limits.md#why-is-there-an-interstitial-in-front-of-my-html-content). ## Reference diff --git a/docs/k8s/advanced-deployments.mdx b/docs/k8s/advanced-deployments.mdx index d6e65c2a0..c52e3265e 100644 --- a/docs/k8s/advanced-deployments.mdx +++ b/docs/k8s/advanced-deployments.mdx @@ -10,7 +10,7 @@ This page covers more advanced deployment options for the operator. It is recomm ## White Label Agent Ingress -If you're running the ngrok operator behind a corporate firewall, you may encounter connectivity issues due to the agent or controller not being able to communicate with the ngrok network edge. If you're facing such issues, you can run the ngrok cli command, which is documented [here](/guides/running-behind-firewalls) to diagnose the problem. +If you're running the ngrok operator behind a corporate firewall, you may encounter connectivity issues due to the agent or controller not being able to communicate with the ngrok network edge. If you're facing such issues, you can run the ngrok cli command, which is documented [here](/guides/other-guides/running-behind-firewalls) to diagnose the problem. However, if opening connectivity is not an option, you can set up a custom ingress domain on your dashboard. This way, you can configure the operator to use the custom domain instead of the default ngrok.app domain. diff --git a/docs/using-ngrok-with/mysql.md b/docs/using-ngrok-with/mysql.md index 233d06456..8e7f14891 100644 --- a/docs/using-ngrok-with/mysql.md +++ b/docs/using-ngrok-with/mysql.md @@ -18,5 +18,6 @@ You can then use the ngrok TCP address and port for any tool that you'd like to The following guides offer step-by-step instructions for configuring site-to-site connectivity with your database. -- [Configure Site-to-Site Connectivity for Databases](/guides/site-to-site-dbs) -- [Configure Site-to-Site Connectivity for Databases with mTLS](/guides/site-to-site-dbs-mtls) +- [Configure Site-to-Site Connectivity for + Databases](/guides/site-to-site-connectivity/dbs.mdx) +- [Configure Site-to-Site Connectivity for Databases with mTLS](/guides/site-to-site-connectivity/dbs-mtls.mdx) diff --git a/docs/using-ngrok-with/rtmp.md b/docs/using-ngrok-with/rtmp.md index a665df48e..9c31cb75e 100644 --- a/docs/using-ngrok-with/rtmp.md +++ b/docs/using-ngrok-with/rtmp.md @@ -17,5 +17,5 @@ rtmp://your-ngrok-tcp-address:ngrok-port/live/ ``` ::::note -Streaming data can eat up a lot of bandwidth quickly. If you are on a free plan, you may run into the [data transfer limits](/guides/limits/#data-transfer-out) and need to upgrade to a paid plan. +Streaming data can eat up a lot of bandwidth quickly. If you are on a free plan, you may run into the [data transfer limits](/guides/other-guides/limits.md#data-transfer-out) and need to upgrade to a paid plan. :::: diff --git a/docs/whats-new.mdx b/docs/whats-new.mdx index ea607987d..56b6014e7 100644 --- a/docs/whats-new.mdx +++ b/docs/whats-new.mdx @@ -70,7 +70,8 @@ You can expect this page to update regularly (at least monthly). We'll include t - 2024-04-30 - Added a new [Bot Users API](/api/resources/bot-users/) to allow programmatic management or bot users in your account. - 2024-04-24 - Released [ngrok Agent 3.9.0](/agent/changelog/#ngrok-agent-390---2024-04-24). -- 2024-04-17 - The abuse interstitial is now displayed for all endpoints in free accounts. See our [guide on Free tier limits](/docs/guides/limits/#why-is-there-an-interstitial-in-front-of-my-html-content) for information about disabling it. +- 2024-04-17 - The abuse interstitial is now displayed for all endpoints in free + accounts. See our [guide on Free tier limits](/docs/guides/other-guides/limits.md#why-is-there-an-interstitial-in-front-of-my-html-content) for information about disabling it. - 2024-04-17 - Enabled Live View for Traffic Inspector. Your traffic events will automatically refresh every few seconds when you have this enabled. It can be disabled and customized from the dashboard. - 2024-04-16 - Enabled [Request Replay for Traffic Inspector](/docs/obs/traffic-inspection/#replay). You can now replay any request to your backend directly from the Dashboard once you have enabled Full Capture. - 2024-04-09 - Added [`compress-response`](/docs/http/traffic-policy/actions/compress-response/) action to the Policy Module.