The ngrok Cheat Sheet
The biggest challenge of ngrok isnβt getting started. In fact, thatβs the easiest part. You can start as simply as
ngrok http 80
and you have your local server online in one line. Quick, simple, and to the point.
Instead, the biggest challenge is two fold: knowing what you can do and then knowing how to do it. Towards that goal, our documentation walks you through every option, configuration, and setting you can use but even that can be daunting.
As of today, weβve launched the ngrok Cheat Sheet in both pdf and png form.
The ngrok Cheat Sheet walks you through each of the core concepts starting from the basics. Print it and hang it on your wall or download it and keep it on hand.
Installation
1. Download ngrok
Or via another package manager: https://ngrok.com/ngrok.com/downloadβ
2. Sign up and get an authtoken
3. Add the authtoken to the ngrok agent
Expose different types of servers
Add Social Login
Facebook:β
Google for specific email domains:β
Github with consent for repository management:
For more providers, visit our doc
Add webhook verification
βFor more providers, visit our doc
Other cool features
Allow access only to your IP:
βDeny access to any IPv6 requesters:β
Add Circuit breaking (reject requests when 5XX responses exceed a 15% ratio):β
Add HTTP compression (gzip compress http responses):β
Add requester's country to request header:β
Add requester's geo latitude to request header::β
Add security header to HTTP response::
βFor more providers, check our modules and http headers
Or mix and match like a mad scientist
HTTP access with Facebook Login, compression, and circuit-breaker at 50%:
βSSH access restricted to your IP:β
Access to a file only for your best friend with Google Social Auth:
What's next?
In addition to development, you can use ngrok to:
- Enable remote access without VPNs
- Access and managing remote software agents and IoT devices
- Enable access to web applications in production
β