ngrok README

The project's README from github.com/inconshreveable/ngrok. As one markdown file: README.md.

ngrok - Unified Ingress for Developers

https://ngrok.com

ngrok Community on GitHub

If you are having an issue with the ngrok cloud service please open an issue on the ngrok community on GitHub

This repository is archived

This is the GitHub repository for the old v1 version of ngrok which was actively developed from 2013-2016.

This repository is archived: ngrok v1 is no longer developed, supported or maintained.

Thank you to everyone who contributed to ngrok v1 it in its early days with PRs, issues and feedback. If you wish to continue development on this codebase, please fork it.

ngrok's cloud service continues to operate and you can sign up for it here: https://ngrok.com/signup

What is ngrok?

ngrok is a globally distributed reverse proxy that secures, protects and accelerates your applications and network services, no matter where you run them. You can think of ngrok as the front door to your applications. ngrok combines your reverse proxy, firewall, API gateway, and global load balancing into one. ngrok can capture and analyze all traffic to your web service for later inspection and replay.

To use ngrok, sign up at https://ngrok.com/signup

ngrok open-source development

ngrok continues to contribute to the open source ecosystem at https://github.com/ngrok with:

What is ngrok for?

What can you do with ngrok?

ngrok (inconshreveable/ngrok)

Searching Database…

24.4K ·GitHub
archived
What is this?ngrok is a globally distributed reverse proxy that secures, protects and accelerates applications and network services wherever they run, combining a reverse proxy, firewall, API gateway and global load balancer into one tool.
Is this the current ngrok, or something older?This repo is the old v1 codebase from 2013-2016 and is archived; it is no longer developed, supported or maintained. The actual 'ngrok' product today is a separate, still-running cloud service you sign up for.
How do I actually use ngrok?You sign up for ngrok's cloud service and run the ngrok agent as the front door to your app; this repository itself is not the thing you install to use the service.
Can I still build and extend this v1 code?You can, but it receives no official support, fixes, or updates; the maintainers suggest forking it if you want to keep developing on this old codebase.
Who is ngrok built for?Developers who need to expose local or internal services to the internet for demos, webhook testing, API gateways, or device connectivity.
What can I actually do with ngrok?Common uses include site-to-site connectivity to customer networks, demoing local apps without deploying them, testing webhooks by replaying HTTP callbacks, running a global API gateway with rate limiting and JWT auth, connecting IoT device APIs to the cloud, and inspecting/replaying HTTP traffic.
Are there SDKs for integrating ngrok into my own code?Yes, ngrok maintains agent SDKs for Python, JavaScript, Go, Rust and Java, plus a Kubernetes operator, as part of its ongoing open-source work (separate from this archived v1 repo).
Should I start a new project with this repository?No. Since this is the unmaintained v1 codebase, new users should sign up for the live ngrok cloud service instead of building from this archived source.
What are similar projects?frp, tyk, nps, nginx, apisix, traefik, SafeLine, zuul
Size
0.7 MB
Stars
24.4K
Updated
CommitApr 26
Age
13y
Commits · 90 Days