From 10e842bd3348eaac6a799a94aaadb4756049cbcd Mon Sep 17 00:00:00 2001
From: SG <212444234+sg-writer@users.noreply.github.com>
Date: Thu, 6 Nov 2025 09:25:31 -0800
Subject: [PATCH 1/3] first full pass
---
agent/overview.mdx | 85 ++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 85 insertions(+)
create mode 100644 agent/overview.mdx
diff --git a/agent/overview.mdx b/agent/overview.mdx
new file mode 100644
index 0000000000..c8b3096848
--- /dev/null
+++ b/agent/overview.mdx
@@ -0,0 +1,85 @@
+---
+title: Secure Tunnels Overview
+sidebarTitle: Overview
+description: Learn about ngrok's secure tunnel agent for exposing local services, connecting devices, and creating secure remote access.
+---
+
+The ngrok agent is a lightweight command-line program that creates secure tunnels from ngrok's global network to your local services, devices, and applications.
+It enables you to expose services behind firewalls and NATs, connect remote devices, and create secure site-to-site connectivity without complex network configuration.
+
+- It runs as a standalone executable with zero runtime dependencies on all major operating systems.
+- It supports HTTP, HTTPS, TCP, and TLS protocols for any application or service.
+- You can run multiple endpoints simultaneously and manage them via configuration files or the CLI.
+- It installs as a native OS service for automatic startup, crash recovery, and background operation.
+
+## Concepts
+
+Here are the core elements you should familiarize yourself with to make the most of ngrok's secure tunnels:
+
+
+
+ Use command-line commands to start endpoints, manage configuration, and interact with the ngrok API.
+
+
+ Define multiple endpoints, customize behavior, and manage complex tunnel configurations with YAML.
+
+
+ Authenticate your agent with ngrok and create endpoints using credentials scoped to your account.
+
+
+ Secure traffic with end-to-end encryption by terminating TLS at the agent for zero-knowledge security.
+
+
+ Create secure tunnels using SSH public key authentication for agent connections.
+
+
+
+## Features
+
+Here are the primary capabilities of ngrok's secure tunnel agent:
+
+- [Multiple protocols](/agent/) - Create HTTP, HTTPS, TCP, and TLS endpoints for any application or service.
+- [Background service](/agent/#running-ngrok-in-the-background) - Install as a native OS service with automatic startup and crash recovery.
+- [Remote management](/agent/#remote-management) - Stop, restart, or upgrade agents remotely via API or dashboard.
+- [Custom connect URLs](/agent/connect-url/) - Brand your agent connections with custom domains for white-label deployments.
+- [API integration](/agent/cli-api/) - Built-in CLI for the ngrok API to manage endpoints, domains, and resources programmatically.
+
+## Use cases
+
+Here are some of the most common use cases for ngrok's secure tunnel agent:
+
+
+
+ Bridge localhost development with the public internet for AI coding tools, webhook testing, and real authentication flows.
+
+
+ Give each developer their own public URL to route traffic and webhooks into their local development environment.
+
+
+ Centralize webhook validation and routing from third-party providers to secure your integrations.
+
+
+ Create an API gateway with internal agent endpoints and centralized traffic management policies.
+
+
+
+## What's next?
+
+- Get started by [installing the ngrok agent](/getting-started/#2-install-the-ngrok-agent-cli) and creating your first tunnel.
+- Learn how to [configure multiple endpoints](/agent/config/) and run the agent as a service.
From 6fa6d2031c9d678853c8276b7207356790a5bc07 Mon Sep 17 00:00:00 2001
From: SG <212444234+sg-writer@users.noreply.github.com>
Date: Thu, 6 Nov 2025 14:59:19 -0800
Subject: [PATCH 2/3] progress, sidebar
---
agent/index.mdx | 2 +-
agent/overview.mdx | 4 ++--
docs.json | 1 +
3 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/agent/index.mdx b/agent/index.mdx
index 74dee3a84c..3e5e73331b 100644
--- a/agent/index.mdx
+++ b/agent/index.mdx
@@ -1,6 +1,6 @@
---
title: ngrok Agent
-sidebarTitle: Overview
+sidebarTitle: ngrok Agent
description: The ngrok agent is a lightweight command-line program that forwards traffic from endpoints it creates on the ngrok cloud service to your upstream application services.
---
diff --git a/agent/overview.mdx b/agent/overview.mdx
index c8b3096848..7a17f8d96c 100644
--- a/agent/overview.mdx
+++ b/agent/overview.mdx
@@ -65,7 +65,7 @@ Here are some of the most common use cases for ngrok's secure tunnel agent:
Centralize webhook validation and routing from third-party providers to secure your integrations.
@@ -81,5 +81,5 @@ Here are some of the most common use cases for ngrok's secure tunnel agent:
## What's next?
-- Get started by [installing the ngrok agent](/getting-started/#2-install-the-ngrok-agent-cli) and creating your first tunnel.
+- Get started by [installing the ngrok agent](/getting-started/) and creating your first tunnel.
- Learn how to [configure multiple endpoints](/agent/config/) and run the agent as a service.
diff --git a/docs.json b/docs.json
index d9bfd9f559..42de8e92a1 100644
--- a/docs.json
+++ b/docs.json
@@ -433,6 +433,7 @@
{
"item": "Secure Tunnels",
"pages": [
+ "agent/overview",
"agent/index",
"agent/web-inspection-interface",
{
From 65d9cd33bd8020a6266b5380f8d07aceed3e0452 Mon Sep 17 00:00:00 2001
From: SG <212444234+sg-writer@users.noreply.github.com>
Date: Mon, 17 Nov 2025 15:46:00 -0800
Subject: [PATCH 3/3] Shaquil and BMG reviews
Co-authored-by: Shaquil Hansford
---
agent/overview.mdx | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/agent/overview.mdx b/agent/overview.mdx
index 7a17f8d96c..400a29370e 100644
--- a/agent/overview.mdx
+++ b/agent/overview.mdx
@@ -18,16 +18,16 @@ Here are the core elements you should familiarize yourself with to make the most
- Use command-line commands to start endpoints, manage configuration, and interact with the ngrok API.
+ Use the command line to start endpoints, manage configuration, and interact with the ngrok API.
- Define multiple endpoints, customize behavior, and manage complex tunnel configurations with YAML.
+ Define multiple endpoints, run multiple tunnels simultaneously, and manage complex tunnel configurations with YAML.
Authenticate your agent with ngrok and create endpoints using credentials scoped to your account.
- Secure traffic with end-to-end encryption by terminating TLS at the agent for zero-knowledge security.
+ Secure traffic with end-to-end encryption by terminating TLS at the agent.
Create secure tunnels using SSH public key authentication for agent connections.
@@ -38,7 +38,7 @@ Here are the core elements you should familiarize yourself with to make the most
Here are the primary capabilities of ngrok's secure tunnel agent:
-- [Multiple protocols](/agent/) - Create HTTP, HTTPS, TCP, and TLS endpoints for any application or service.
+- [Support for multiple protocols](/agent/) - Create HTTP, HTTPS, TCP, and TLS endpoints for any application or service.
- [Background service](/agent/#running-ngrok-in-the-background) - Install as a native OS service with automatic startup and crash recovery.
- [Remote management](/agent/#remote-management) - Stop, restart, or upgrade agents remotely via API or dashboard.
- [Custom connect URLs](/agent/connect-url/) - Brand your agent connections with custom domains for white-label deployments.