Merge branch 'main' into justngrok-patch-2

.github/workflows/pr.yml → .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

docs/errors/details/_err_ngrok_3200.md

@@ -9,11 +9,11 @@ ngrok is unable to assist withe end user content as all conent is neither hosted
 
 ### 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 ngrok account, and none of these steps work for you or you have additional questions, drop us a note at at [[email protected]](mailto:[email protected]?subject=Help%20with%20ngrok%203200%20error).

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).

docs/guides/limits.md

@@ -77,4 +77,47 @@ 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).

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,