README
¶
ngrok - Introspected tunnels to localhost (homepage)
"I want to securely expose a web server to the internet and capture all traffic for detailed inspection and replay"
What is ngrok?
ngrok is a reverse proxy that creates a secure tunnel between from a public endpoint to a locally running web service. ngrok captures and analyzes all traffic over the tunnel for later inspection and replay.
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.
Developing on ngrok
Directories
¶
| Path | Synopsis |
|---|---|
|
src
|
|
|
code.google.com/p/log4go
Package log4go provides level-based and highly configurable logging.
|
Package log4go provides level-based and highly configurable logging. |
|
github.com/gorilla/websocket
Package websocket implements the WebSocket protocol defined in RFC 6455.
|
Package websocket implements the WebSocket protocol defined in RFC 6455. |
|
github.com/gorilla/websocket/examples/autobahn
Command server is a test server for the Autobahn WebSockets Test Suite.
|
Command server is a test server for the Autobahn WebSockets Test Suite. |
|
github.com/inconshreveable/go-update
go-update allows a program to update itself by replacing its executable file with a new version.
|
go-update allows a program to update itself by replacing its executable file with a new version. |
|
github.com/jteeuwen/go-bindata
bindata converts any file into managable Go source code.
|
bindata converts any file into managable Go source code. |
|
github.com/kardianos/osext
Extensions to the standard "os" package.
|
Extensions to the standard "os" package. |
|
github.com/kr/binarydist
Package binarydist implements binary diff and patch as described on http://www.daemonology.net/bsdiff/.
|
Package binarydist implements binary diff and patch as described on http://www.daemonology.net/bsdiff/. |
|
github.com/nsf/termbox-go
termbox is a library for creating cross-platform text-based interfaces
|
termbox is a library for creating cross-platform text-based interfaces |
|
github.com/rcrowley/go-metrics
Go port of Coda Hale's Metrics library
|
Go port of Coda Hale's Metrics library |
|
github.com/rcrowley/go-metrics/stathat
Metrics output to StatHat.
|
Metrics output to StatHat. |
|
gopkg.in/yaml.v1
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |
|
ngrok/cache
The implementation borrows heavily from SmallLRUCache (originally by Nathan Schrenk).
|
The implementation borrows heavily from SmallLRUCache (originally by Nathan Schrenk). |
|
ngrok/client/views/term
shared internal functions for handling output to the terminal
|
shared internal functions for handling output to the terminal |
|
ngrok/client/views/web
interactive web user interface
|
interactive web user interface |
Click to show internal directories.
Click to hide internal directories.