From 95c9f7f91654b42e207c9398ed2f6e458ae3920a Mon Sep 17 00:00:00 2001 From: Cody A Price Date: Tue, 30 Jul 2024 11:12:37 -0500 Subject: [PATCH 1/8] Switch broken links config from error to warn --- docusaurus.config.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 3a3197dee..2f51e590f 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -30,8 +30,9 @@ const config = { tagline: "online in one line", url: "https://ngrok.com", baseUrl: "/docs/", - onBrokenLinks: "throw", - onBrokenMarkdownLinks: "throw", + onBrokenAnchors: "warn", + onBrokenLinks: "warn", + onBrokenMarkdownLinks: "warn", favicon: "img/favicon.ico", trailingSlash: true, From 92d7802f7bcb2b349e6a1d8524803b8f5e5d55ad Mon Sep 17 00:00:00 2001 From: Cody A Price Date: Tue, 30 Jul 2024 11:24:34 -0500 Subject: [PATCH 2/8] update ci checks gh action --- .github/workflows/{pr.yml => ci-checks.yml} | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) rename .github/workflows/{pr.yml => ci-checks.yml} (71%) diff --git a/.github/workflows/pr.yml b/.github/workflows/ci-checks.yml similarity index 71% rename from .github/workflows/pr.yml rename to .github/workflows/ci-checks.yml index 0aa3cf529..d2a511be6 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/ci-checks.yml @@ -1,13 +1,9 @@ -name: Demo ngrok docs +name: CI Checks -on: - pull_request: - branches: - - main +on: push jobs: - deploy: - name: Demo ngrok docs + ci-checks: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -21,9 +17,9 @@ jobs: - name: 'Create env file' run: | echo DEPLOY_ENV=dev > .env - - name: Install dependencies + - name: Install Dependencies 📥 run: pnpm install --frozen-lockfile - - name: Typecheck + - name: Type Check 🧹 run: pnpm run typecheck - - name: Build website + - name: Build website 📦 run: pnpm run build \ No newline at end of file From a39cc8f8a41aefb323af56c3e459ddc1ae2cee68 Mon Sep 17 00:00:00 2001 From: samcrichard <119348077+samcrichard@users.noreply.github.com> Date: Tue, 30 Jul 2024 11:41:18 -0400 Subject: [PATCH 3/8] Update error page to have dev preview for custom error page This is a way to gauge interest in customized error pages --- docs/errors/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/errors/index.md b/docs/errors/index.md index a310143f1..d30ce4926 100644 --- a/docs/errors/index.md +++ b/docs/errors/index.md @@ -56,3 +56,7 @@ listed here to help make your troubleshooting easier. Consult the [Errors Reference Documentation](/docs/errors/reference) for a complete list of all of ngrok's error codes. + +## Customize Error Pages for your Traffic + +To access and provide feedback on a development preview of custom error pages [Fill out the form]((https://ngrok.com/new-features/custom-error-pages?ref=errordoc)). From 7f05bd3629722f30f499dd002a9d9c06096cf7a6 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Tue, 30 Jul 2024 15:43:04 +0000 Subject: [PATCH 4/8] ci: apply automated fixes --- docs/errors/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/errors/index.md b/docs/errors/index.md index d30ce4926..9554a88e4 100644 --- a/docs/errors/index.md +++ b/docs/errors/index.md @@ -59,4 +59,4 @@ complete list of all of ngrok's error codes. ## Customize Error Pages for your Traffic -To access and provide feedback on a development preview of custom error pages [Fill out the form]((https://ngrok.com/new-features/custom-error-pages?ref=errordoc)). +To access and provide feedback on a development preview of custom error pages [Fill out the form](<(https://ngrok.com/new-features/custom-error-pages?ref=errordoc)>). From a9936792860148208c902d566ddac50d0b06b151 Mon Sep 17 00:00:00 2001 From: Cody A Price Date: Tue, 30 Jul 2024 14:18:43 -0500 Subject: [PATCH 5/8] fix broken link --- docs/errors/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/errors/index.md b/docs/errors/index.md index 9554a88e4..e359f60ed 100644 --- a/docs/errors/index.md +++ b/docs/errors/index.md @@ -59,4 +59,4 @@ complete list of all of ngrok's error codes. ## Customize Error Pages for your Traffic -To access and provide feedback on a development preview of custom error pages [Fill out the form](<(https://ngrok.com/new-features/custom-error-pages?ref=errordoc)>). +To access and provide feedback on a development preview of custom error pages [Fill out the form](https://ngrok.com/new-features/custom-error-pages?ref=errordoc). From d9ddbfc0c05fcff8e1c38592a6be6fe7c2d727c4 Mon Sep 17 00:00:00 2001 From: Niji Date: Wed, 31 Jul 2024 09:00:24 -0700 Subject: [PATCH 6/8] feat: add headings to common 3200 errors (#873) Make it easier to scan the 3200 common errors by adding some bold headings. --- docs/errors/details/_err_ngrok_3200.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/errors/details/_err_ngrok_3200.md b/docs/errors/details/_err_ngrok_3200.md index 03574a132..bbf51f500 100644 --- a/docs/errors/details/_err_ngrok_3200.md +++ b/docs/errors/details/_err_ngrok_3200.md @@ -6,11 +6,11 @@ If you are the ngrok Administrator for this account, please verify that the ngro ### The most common causes of this error are: -- The ngrok Agent is no longer running, or you forgot to start the Agent. Verify that the Agent is running and showing the expected "Forwarding" address. -- The Agent session has timed out or stopped. Restart the ngrok Agent to restart the Agent and tunnel sessions. -- The endpoint domain/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. -- 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. -- 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. -- 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. +- **Agent Not Running** The ngrok Agent is no longer running, or you forgot to start the Agent. Verify that the Agent is running and showing the expected "Forwarding" address. +- **Session Timed Out or Stopped** The Agent session has timed out or stopped. Restart the ngrok Agent to restart the Agent and tunnel sessions. +- **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. If you are the Administrator for this account, and none of these steps work for you or you have additional questions, drop us a note at at [support@ngrok.com](mailto:support@ngrok.com?subject=Help%20with%20ngrok%203200%20error). From 4da942e908e2e3f4ce3198db9ae37e0e5d940013 Mon Sep 17 00:00:00 2001 From: justngrok Date: Tue, 30 Jul 2024 10:59:43 -0600 Subject: [PATCH 7/8] Update limits.md Added Interstital bypass examples for common libraries. Can these be displayed a better way? --- docs/guides/limits.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/docs/guides/limits.md b/docs/guides/limits.md index 50a59654d..14500e1c5 100644 --- a/docs/guides/limits.md +++ b/docs/guides/limits.md @@ -77,4 +77,42 @@ If the interstitial interferes with your project, you can bypass it in a few way - Change your user agent by setting the `User-Agent` header to something non-standard, such as `MyApp/0.0.1`, to bypass the warning. - Upgrading to any of our paid plans will also bypass the warning. +### Code Examples +Axios +``` +axios.get(url, { 'headers': { 'ngrok-skip-browser-warning': '1' } }) + .then((response => { + console.log(response.data); + }) + .catch((error) => { + console.log(error); + }); +``` + +Fetch +``` +const response = await fetch(URL, { + headers: { + "ngrok-skip-browser-warning": "1", + }, + // ... +}); +``` + +SuperAgent +``` + request + .get('/endpoint') + .set('ngrok-skip-browser-warning', '1') + .then(callback); +``` + +JQuery +``` + request + .get('/endpoint') + .set('ngrok-skip-browser-warning', '1') + .then(callback); +``` + If you are a developer trying to access your own endpoint, you can use a browser extension to customize your browser's user agent value. Here is an [example for Chrome](https://chromewebstore.google.com/detail/requestly-intercept-modif/mdnleldcmiljblolnjhpnblkcekpdkpa?hl=en-US). From 8014bcc998775d67bec7c8e427cf52b7cc6e2cca Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Tue, 30 Jul 2024 17:01:51 +0000 Subject: [PATCH 8/8] ci: apply automated fixes --- docs/guides/limits.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/guides/limits.md b/docs/guides/limits.md index 14500e1c5..23b586c68 100644 --- a/docs/guides/limits.md +++ b/docs/guides/limits.md @@ -78,7 +78,9 @@ If the interstitial interferes with your project, you can bypass it in a few way - Upgrading to any of our paid plans will also bypass the warning. ### Code Examples + Axios + ``` axios.get(url, { 'headers': { 'ngrok-skip-browser-warning': '1' } }) .then((response => { @@ -90,6 +92,7 @@ axios.get(url, { 'headers': { 'ngrok-skip-browser-warning': '1' } }) ``` Fetch + ``` const response = await fetch(URL, { headers: { @@ -100,6 +103,7 @@ const response = await fetch(URL, { ``` SuperAgent + ``` request .get('/endpoint') @@ -108,6 +112,7 @@ SuperAgent ``` JQuery + ``` request .get('/endpoint')