When we develop on localhost, we usually use some kind of simple HTTP server like node, our Oracle database,APIs, webhooks, Callback Urls or whatever.
This is all good and we are all pretty happy about that. We have access to our app using our fancy
This is all good and we are all pretty happy about that. We have access to our app using our fancy
http://localhost
url. We are happy, but alone.
What if you would like to share your app to a colleague that is not on the same network as yours ? What if you need to check your app on an SSL connection? What if you wanted an external system to pass you a process invoked by a method ?
ngrok to the rescue
Ngrok is a simple “free” service that can help you with that. Here’s some of the features that it provides:
- Expose your locally hosted app/website to the outside world by providing you a
http(s)://{something}.ngrok.io
url. - Allows you to have an SSL connection to your localhost environment.
- Inspect/replay the requests made to your local environment
- Custom subdomain (required a premium account)
- Password protect your exposed service
- And more...
Installing
To install, you have different options to choose from
To install, you have different options to choose from
- The official way: Downloading a zip file and unzip it
- Using NPM/Yarn :
npm install ngrok -g
. Package information here
It’s a good idea here to create a free account in order to increase the connections rate limit from 20 to 40. The process is quick and really easy.
Exposing our localhost:8080(can be any port) port
You can see that ngrok gives us now access to 3 urls:
- http://4fc79cf7.ngrok.io : Our webapp on standard http protocol
- https://4fc79cf7.ngrok.io : Our webapp on secure https protocol
- http://127.0.0.1:4040 : A nice web interface to inspect our tunnel
Password protect our tunnel
Here’s how you can add a username/password authentication to your tunnel
This will protect your tunnel with the login hello and password world
Exposing SSH server on port 22
Here’s how you can expose your local machine SSH port to the world. Pretty dangerous but do that if you know what you’re doing.
What about using Virtual Hosts?
You just need to include the host-header flag
For example, if I wanna expose the virtual host/docker: demo.local.vh:80
More information?
Free user plan:
- HTTP/TCP tunnels on random URLs/ports
- 1 online ngrok process
- 4 tunnels per ngrok process
- 40 connections / minute (error 429)
Conclusion
Ngrok is a powerful tool to expose your local services through secure tunnels.You can use it to expose web servers,API Rest,SSH, databases and many others for free.
Happy Apexing.!
Great blog Benjamin!
ReplyDelete