In Create a Web Server in Node without any Code, we used the http-server npm module to create a web server and serve up files in record time. Today I will share a way you can take the web server you built and make it available beyond your local network and on the public Internet. This is pretty cool trick, but I recommend that you use this with caution as this will open up a hole in your router/firewall when you make your web server available to the world.
Once again, we are using Node.js and so this will work on a variety of platforms. I am focusing here on making this work in the context of Raspberry Pi which is an amazing little machine for IoT applications and everything else under the sun. Ok, let’s get rolling.
Log into your RasPi from a Windows system by launching a Windows Remote Desktop Connection. (Hit the Windows key on your keyboard and type Remote Desktop Connection to get started.) This method of remote connection works since we installed xrdp on the RasPi as part of our Beginners Guide to Installing Node.js on a Raspberry Pi 2. Of course, you can connect the RasPi directly to a monitor/keyboard/mouse or use other remote options such as an X Server and come in through Linux, Mac OS X, etc. too.
After you are in the RasPi, launch a terminal session and type the following:
$ sudo npm install -g localtunnel
This will install the npm package called localtunnel globally so it is available as a command anywhere on the RasPi rather than just in the current directory. The localtunnel package npm page summarizes the mission of this package well:
localtunnel exposes your localhost to the world for easy testing and sharing! No need to mess with DNS or deploy just to have others test out your changes.
Now that we have localtunnel installed, let’s see what kind of parameters it accepts. You will notice that we invoke localtunnel with “lt” which is the command that is created as part of the global installation.
$ lt --help
Usage: lt --port [num] <options>
-h, --host Upstream server providing forwarding [default: "http://localtunnel.me"]
-s, --subdomain Request this subdomain
-l, --local-host Tunnel traffic to this host instead of localhost, override Host header to this host
-o, --open opens url in your browser
-p, --port Internal http server port [required]
--help Show this help and exit [boolean]
--version Show version number [boolean]
We see a very nice, simple help page. I’m going to use the single-character options (e.g. -p) instead of the long option parameter names (e.g. –port). Please note that you must use two dashes (–port) when using long option names rather than one dash in order for localtunnel to understand and honor the long option name parameters you are passing.
We first need to get our Web server back up and running so that we can make it available to the world. Launch a new terminal session (leave the other first terminal session open still) and enter the following commands:
$ cd Public
This will make the index.html file and any other files you have residing in your
/home/pi/Public directory available to be served up by the web server.
Next, jump back over to the original terminal session you launched so we can get localtunnel working. Let’s tunnel through to our web server running on port 8080 and launch the local web browser to view our web server from the outside world. (You can follow along by reviewing the options that are listed in the help info above.)
$ lt -p 8080 -o
Fantastic! Upon launching the above command, we are assigned a random subdomain such as http://jxloprztp.localhost.me and we now have our web server available on the real Internet. Go to another machine besides your RasPi such as a laptop/desktop or cell phone so that you can see for yourself that your website has hit the big time and is available everywhere! 🙂
You can now hit Ctrl-C in the terminal window running localtunnel to break the tunnel connection. Pretty amazing technology, eh?
Local tunnel has some other options. For example, you can choose your own subdomain rather than being assigned a random subdomain. Let’s try that now:
$lt -p 8080 -s mypizzaweb -o
Assuming nobody is actively using the mypizzaweb subdomain, you can now navigate to it by typing “http://mypizzaweb.localtunnel.me” in your Web browser address bar.
Once again, be sure to hit Ctrl-C in the terminal window running localtunnel to break the tunnel connection. It’s the wild west out there.
That’s it until next time!
Follow Dave Johnson on Twitter to stay up to date on the latest tutorials and tech articles.