Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion agent/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
---

Expand Down
85 changes: 85 additions & 0 deletions agent/overview.mdx
Original file line number Diff line number Diff line change
@@ -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:

<Columns cols={1}>
<Card title="Agent CLI" href="/agent/cli/" horizontal>
Use the command line to start endpoints, manage configuration, and interact with the ngrok API.
</Card>
<Card title="Configuration File" href="/agent/config/" horizontal>
Define multiple endpoints, run multiple tunnels simultaneously, and manage complex tunnel configurations with YAML.
</Card>
<Card title="Authtokens" href="/agent/#authtokens" horizontal>
Authenticate your agent with ngrok and create endpoints using credentials scoped to your account.
</Card>
<Card title="TLS Termination" href="/agent/agent-tls-termination/" horizontal>
Secure traffic with end-to-end encryption by terminating TLS at the agent.
</Card>
<Card title="SSH Reverse Tunnel" href="/agent/ssh-reverse-tunnel-agent/" horizontal>
Create secure tunnels using SSH public key authentication for agent connections.
</Card>
</Columns>

## 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:

<Columns cols={2}>
<Card
title="Agent-assisted gateway"
icon="code"
href="/universal-gateway/examples/agent-assisted-gateway/"
>
Bridge localhost development with the public internet for AI coding tools, webhook testing, and real authentication flows.
</Card>
<Card
title="Secure developer environments"
icon="shield"
href="/universal-gateway/examples/secure-developer-environments/"
>
Give each developer their own public URL to route traffic and webhooks into their local development environment.
</Card>
<Card
title="Webhook gateway"
icon="link"
href="/universal-gateway/examples/webhook-gateway/"
>
Centralize webhook validation and routing from third-party providers to secure your integrations.
</Card>
<Card
title="API gateway"
icon="globe"
href="/guides/api-gateway/get-started/"
>
Create an API gateway with internal agent endpoints and centralized traffic management policies.
</Card>
</Columns>

## 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.
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,7 @@
{
"item": "Secure Tunnels",
"pages": [
"agent/overview",
"agent/index",
"agent/web-inspection-interface",
{
Expand Down