README

node-localtunnel

Node.js wrapper for the localtunnel ruby client

Features

should start the localtunnel client
should error if the binary does not exist
should error if stopped before started
should error if started when already running

Prerequisites

The ruby localtunnel client should be installed and correctly configured with a public key

Installation

npm install localtunnel-wrapper

API

var LocalTunnel = require('localtunnel-wrapper');

var localTunnel = new LocalTunnel(8080);
localTunnel.start(function(error, hostname) {
  if (error) {
    console.log(error);
  } else {
    // Now forwarding to local port 8080 through localtunnel.com
    // The assigned hostname is given in the hostname parameter

    localTunnel.stop(function(error) {
      if (error) {
        console.log(error);
      } else {
        // tunnel has stopped
      }
    });
  }
});

Roadmap

Nothing yet

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using ./grunt.sh or .\grunt.bat.

localtunnel-wrapper

Usage no npm install needed!