Overview

ngrok is your app's front door. ngrok is a globally distributed reverse proxy that secures, protects and accelerates your applications and network services, no matter where you run them. ngrok supports delivering HTTP, TLS or TCP-based applications. More about how ngrok works →

You can use ngrok in development for webhook testing or in production as an API Gateway, Kubernetes Ingress, or Identity-Aware Proxy. You can also run ngrok to easily create secure connectivity to APIs in your customers' networks or on your devices in the field. More about what you can do with ngrok →

Get Started

Quickstart

Put your app on the internet with the ngrok agent in less than a minute.

Get started with ngrok →

Or instead of the ngrok agent, get started another way:

Go SDK

Rust SDK

JavaScript SDK

Kubernetes Operator

Docker

SSH -R

Modules

Once ngrok is in front of your app, you can add authentication, acceleration, transformation, and other behaviors.

Basic Auth

Require a username and password with HTTP Basic Auth.

IP Restrictions

Allow or deny traffic based on the source IP of connections.

OAuth

Enforce an OAuth flow to well-known IdPs like Google.

Webhook Verification

Verify HTTP requests are signed by a webhook provider like Slack or GitHub.

Request Headers

Add or remove headers from HTTP requests before they are sent to your upstream service

OpenID Connect

Enforce an OpenID Connect flow to a federated IdP.

Mutual TLS

Enforce mutual TLS auth with a configured set of CAs.

SAML

Enforce a SAML flow to a federated IdP, optionally authorizing users by group.

User Agent Filter

Block bots and browsers with rules that allow or deny HTTP requests based on User-Agent header.

Circuit Breaker

Protect upstream services by rejecting traffic when they become overwhelmed.

All Modules →

Reference

Agent CLI

Agent CLI commands and options

Agent Config File

Options for ngrok.yml: the agent config file

API Reference

HTTP API resources and methods for api.ngrok.com

Events

All observable events and event payload shapes

Header Template Variables

Variables you can template into request or response headers.

Errors

Codes for every unique error condition returned by ngrok

Go

ngrok-go package docs on pkg.go.dev

Rust

ngrok-rust crate docs on docs.rs

JavaScript / TypeScript

ngrok-javascript module docs

Python

ngrok-python package docs

All Agent SDKs →

Guides

Follow tutorials for common tasks when working with ngrok.

Inspect your traffic

View your app's traffic in real time with the ngrok agent's inspection interface

Bring your own domain

Use ngrok with your own domain by setting up a DNS CNAME record

All Guides →