Expose localhost to the internet with Ngrok

ngrok-install.md

Expose Localhost to the Internet With Ngrok

If you want a way to access your localhost easily on the public internet, lets say, to showcase the current work to a client, etc. This is where ngrok comes in. It allows us to establish a tunnel that forwards a port on our machine and make it available on the internet.

Ngrok is a Go program, distributed as a single executable file for all major desktop platforms. There are no additional frameworks to install or other dependencies.

This tutorial assumes you are using MAMP and have previously set up DNSMASQ.

Step 1: Install ngrok

$ cd /tmp
$ wget https://dl.ngrok.com/darwin_amd64/ngrok.zip
$ unzip ngrok.zip
$ chmod +x ngrok
$ cp ngrok /usr/local/bin

Check to make sure it's install properly

$ ngrok -help

Step 2: Signup online

Signup online free to enable several different . Follow the instruction on the site to register ngrok on your computer. You'll only need to register once.

Step 3: Add Dynamic Virtual Hosts to your Apache configuration

Open up /Applications/MAMP/conf/apache/httpd.conf in a text editor, scroll down, and add *.ngrok.com to the following line to the file.

ServerAlias *.dev *.work *.xip.io *.ngrok.com

To make this all work, we need ngrok to serve the site correctly. Assuming we want to access myapp.dev, we will need to issue a command like this:

# access `myapp.dev` via: http://myapp.dev.ngrok.com
$ ngrok --subdomain=myapp.dev myapp.dev:80

Step 4: Create shortcut to launch ngrok

Add the following /user/<username>/.bashrc

ngrok_tunnel() {
    website=$1
    subdomain=$2
    username=$3
    password=$4
    [ -n $website ] || (echo "I need a local website to tunnel to." && exit)
    [ -n $subdomain ] && subdomain="--subdomain=${subdomain}"
    if [[ -n $username  ]] && [[ -n $password ]]; then
        httpauth="-httpauth=${username}:${password}"
    else
        echo "Not using secure tunnel since auth params were not provided."
    fi
    ngrok $subdomain $httpauth $website
}

expose() { ngrok_tunnel $1:80 $1 $2 $3; }

Reload bashrc

$ . ~/.bashrc

Now, to serve up the site, e.g. myapp.dev, we can simply run:

$ expose myapp.dev

Additionally, we can enable HTTP Basic Authentication while serving up a local site, by simply passing two more parameters for username and password, like this:

$ expose myapp username password

Now, when we visit http://myapp.dev.ngrok.com, we will be greeted with a HTTP Basic Authentication before we are allowed accessed to our local site.

Additional Information

http://nikhgupta.com/workflow/making-ngrok-work-with-pow-and-apache-exposing-localhost-domains-to-the-internet/
http://adrianartiles.com/webhook-testing-and-exposing-localhost-to-the-internet-with-ngrok
https://ngrok.com/
https://ngrok.com/dashboard