Fork me on GitHub

Project Notes

ngrok

Creating publically-accessible URLs for services running locally.

Notes

When developing software it is often really convenient to be able to run a publically-accessible URL for the code when it is still in development or testing. A common scenario is when developing intergrations with commercial cloud services.

One could deploy the software to a cloud instance, or jump through the hoops of setting up a publically accessible server. These invove the hassle of deploying software, setting up servers and making sure on stays safe and secure.

In many cases, ngrok.com provides a much more convenient solution: It essentially sets up a personal proxy service with unique publically accessible URLs (HTTP and HTTPS) that routes traffic to a local port. It does this without needing to change any firewall or NAT settings

Installation

Installation is a simple exeutable download:

  • download a zip file
  • unpack it and put the ngrok executable somewhere convenient

It runs:

$ ngrok version
ngrok version 2.3.40

Configuration

Requires an account

$ ngrok authtoken <token>

Simple Example

Running HTTP Mock Responses on http://localhost:4567. Here’s an example response when called directly on localhost:

$ curl http://localhost:4567/200.json
{
  "message": "Returning code 200 in json format"
}

Now starting up ngrok for this port

$ ngrok http 4567

ngrok_4567

Now can access vai HTTP over the open net using the auto-generated URL:

$ curl http://d7ee-2406-3003-2060-3754-935-f710-c2cc-d2fb.ngrok.io/200.json
{
  "message": "Returning code 200 in json format"
}

Or HTTPS/TLS:

$ curl https://d7ee-2406-3003-2060-3754-935-f710-c2cc-d2fb.ngrok.io/200.json
{
  "message": "Returning code 200 in json format"
}

The assigned URLs will recycle on every restart of ngrok, however a paid account can get persistent domain names and other features

Credits and References

About LCK#192 Tools
Project Source on GitHub Return to the Project Catalog

This page is a web-friendly rendering of my project notes shared in the LittleCodingKata GitHub repository.

LittleCodingKata is my collection of programming exercises, research and code toys broadly spanning things that relate to programming and software development (languages, frameworks and tools).

These range from the trivial to the complex and serious. Many are inspired by existing work and I'll note credits and references where applicable. The focus is quite scattered, as I variously work on things new and important in the moment, or go back to revisit things from the past.

This is primarily a personal collection for my own edification and learning, but anyone who stumbles by is welcome to borrow, steal or reference the work here. And if you spot errors or issues I'd really appreciate some feedback - create an issue, send me an email or even send a pull-request.