https://github.com/tutumcloud/ngrok

Introspected tunnels to localhost
https://github.com/tutumcloud/ngrok

Last synced: 3 months ago
JSON representation

Introspected tunnels to localhost

• Host: GitHub
• URL: https://github.com/tutumcloud/ngrok
• Owner: tutumcloud
• License: other
• Archived: true
• Fork: true (inconshreveable/ngrok)
• Created: 2016-02-12T10:31:26.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-07-04T00:51:37.000Z (over 6 years ago)
• Last Synced: 2024-06-20T03:38:34.459Z (5 months ago)
• Language: Go
• Homepage:
• Size: 639 KB
• Stars: 141
• Watchers: 16
• Forks: 85
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-network-stuff - **117**星

README

        
[![Build

status](https://travis-ci.org/inconshreveable/ngrok.svg)](https://travis-ci.org/inconshreveable/ngrok)

# ngrok - Introspected tunnels to localhost ([homepage](https://ngrok.com))

### "I want to securely expose a web server to the internet and capture all traffic for detailed inspection and replay"

![](https://ngrok.com/static/img/overview.png)

## 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.0

**NOTE** This repository contains the code for ngrok 1.0. The code for ngrok 2.0 is not open source.

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

## Downloading and installing ngrok

ngrok has _no_ runtime dependencies. Just download a single binary for your platform and run it. Some premium features

are only available by creating an account on ngrok.com. If you need them, [create an account on ngrok.com](https://ngrok.com/signup).

#### [Download ngrok for your platform](https://ngrok.com/download)

## Developing on ngrok

[ngrok developer's guide](docs/DEVELOPMENT.md)