Expose local ports to a public URL with https://localtunnel.me
This plugin requires Grunt.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-localtunnel-me --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-localtunnel-me');
Run this task with the grunt localtunnel
command.
Note that this server only runs as long as grunt is running. Once grunt's tasks have completed, the web server stops. This behavior can be changed with the keepalive option, and can be enabled ad-hoc by running the task like grunt localtunnel:keepalive
.
This task was designed to be used in conjunction with another task that is run immediately afterwards, like the grunt-contrib-qunit plugin qunit
task.
In your project's Gruntfile, add a section named localtunnel
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
localtunnel: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
}
}
})
Type: Integer
Default: 8000
The port to tunnel. Local server should already be listening to this port before attempting to tunnel.
Type: String
Default: undefined
Request a subdomain to tunnel to on https://localtunnel.me.
Type: String
Default: localhost
The local hostname for the requests tunnel.
Type: String | Boolean
Default: false
If true
, opens the browser to the public tunnel page. If a string, the option is treated as a path, eg:
grunt.initConfig({
localtunnel: {
myTunnel: {
options: {
open: '/path/to/workspace/',
subdomain: 'uniqueworkspace'
}
}
}
});
...should expect to open https://uniqueworkspace.localtunnel.me/path/to/workspace/
upon successful tunnel.
Type: Boolean
Default: false
Keep the server alive indefinitely. Note that if this option is enabled, any tasks specified after this task will never run. By default, once grunt's tasks have completed, the web server stops. This option changes that behavior.
This option can also be enabled ad-hoc by running the task like grunt localtunnel:targetname:keepalive
Type: Function
Default: function(err){}
Custom handler for tunnel error. Use grunt --force
to continue execution after grunt.warn
is called upon receiving the error. Receives the tunnel error as its only argument.
Type: Function
Default: function(tunnel){}
Custom handler for tunnel success. Receives the tunnel instance as its only argument.
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.
- 2014-09-03 v0.1.6 Updated dependencies; improved testing.
- 2014-05-14 v0.1.5 Added
tasks/localtunnel.js
asmain
. Should hopefully solve recurring NPM issue. - 2014-05-14 v0.1.4 Problem publishing. Update
localtunnel
dependency. - 2014-05-13 v0.1.3 Fixed bug where
tasks
directory was not included in package. v0.1.2 may be unusable. - 2014-05-13 v0.1.2 Problem publishing. Support
keepalive
option as flag, à la mode ofgrunt-contrib-connect
. - 2014-05-10 v0.1.1 Added
handleTunnelError
&handleTunnelSuccess
options. - 2014-05-10 v0.1.0 Initial Release.
Copyright (c) 2014 Shane Daniel. Licensed under the MIT license.