|
|
@@ -2,15 +2,31 @@
|
|
|
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"
|
|
|
+### ”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.0
|
|
|
-**NOTE** This repository contains the code for ngrok 1.0. The code for ngrok 2.0 is not open source.
|
|
|
+## 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.
|
|
|
|
|
|
## What can I do with ngrok?
|
|
|
- Expose any http service behind a NAT or firewall to the internet on a subdomain of ngrok.com
|
|
|
@@ -26,12 +42,7 @@ ngrok captures and analyzes all traffic over the tunnel for later inspection and
|
|
|
- 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)
|
|
|
+#### [Pre-compiled ngrok 1.x binaries for your platform](https://ngrok.com/download/1)
|
|
|
|
|
|
## Developing on ngrok
|
|
|
[ngrok developer's guide](docs/DEVELOPMENT.md)
|
Alan Shreve