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 new file mode 100644 index 0000000000..400a29370e --- /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 the command line to start endpoints, manage configuration, and interact with the ngrok API. + + + 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. + + + Create secure tunnels using SSH public key authentication for agent connections. + + + +## Features + +Here are the primary capabilities of ngrok's secure tunnel agent: + +- [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. +- [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/) 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 5c5510b2b6..424e618e59 100644 --- a/docs.json +++ b/docs.json @@ -434,6 +434,7 @@ { "item": "Secure Tunnels", "pages": [ + "agent/overview", "agent/index", "agent/web-inspection-interface", {