No Description

Alan Shreve a8e7fa4863 Merge pull request #339 from RealDigitalMedia/default_inspect_addr 2 years ago
assets 749dfd263d Bug fix of width path for web dashboard. 3 years ago
contrib 2e5e6acee3 Changes per suggestions by Alan. 5 years ago
docs 1a56399614 Development doc update: Mercurial is needed to compile ngrok 3 years ago
src a8e7fa4863 Merge pull request #339 from RealDigitalMedia/default_inspect_addr 2 years ago
.gitignore 9df0907ea2 update gitignore 4 years ago
.travis.yml de0f8ede2b no longer build 1.3 2 years ago
CONTRIBUTORS 1088ec6c25 strip email 5 years ago
LICENSE 1f7f65edf5 add license 5 years ago
Makefile 6d6ab48068 fix makefile to allow parallel builds 4 years ago
README.md 9579d5ce5c remove v1 prebuilt download links 2 years ago

README.md

Build
status

ngrok - Introspected tunnels to localhost (homepage)

”I want to expose a local server behind a NAT or firewall to the internet.”

What is ngrok?

ngrok is a reverse proxy that creates a secure tunnel from a public endpoint to a locally running web service. ngrok captures and analyzes all traffic over the tunnel for later inspection and replay.

ngrok 2.x

ngrok 2.x is the successor to 1.x and the focus of all current development effort. Its source code is not available.

NOTE This repository contains the code for ngrok 1.x.

Status of the ngrok 1.x project

ngrok 1.x is no longer developed, supported or maintained by its author, except to ensure that the project continues to compile. The contribution policy has the following guidelines:

  1. All issues against this repository will be closed unless they demonstrate a crash or other complete failure of ngrok's functionality.
  2. All issues against this repository are for 1.x only, any issues for 2.x will be closed.
  3. No new features will be added. Any pull requests with new features will be closed. Please fork the project instead.
  4. Pull requests fixing existing bugs or improving documentation are welcomed.

The ngrok 1.x hosted service

ngrok.com ran a pay-what-you-want hosted service of 1.x from early 2013 until April 7, 2016. Afterwards, it only runs 2.x service.

Production Use

DO NOT RUN THIS VERSION OF NGROK (1.X) IN PRODUCTION. Both the client and server are known to have serious reliability issues including memory and file descriptor leaks as well as crashes. There is also no HA story as the server is a SPOF. You are advised to run 2.0 for any production quality system.

What can I do with ngrok?

  • Expose any http service behind a NAT or firewall to the internet on a subdomain of ngrok.com
  • Expose any tcp service behind a NAT or firewall to the internet on a random port of ngrok.com
  • Inspect all http requests/responses that are transmitted over the tunnel
  • Replay any request that was transmitted over the tunnel

What is ngrok useful for?

  • Temporarily sharing a website that is only running on your development machine
  • Demoing an app at a hackathon without deploying
  • Developing any services which consume webhooks (HTTP callbacks) by allowing you to replay those requests
  • Debugging and understanding any web service by inspecting the HTTP traffic
  • Running networked services on machines that are firewalled off from the internet

Developing on ngrok

ngrok developer's guide