mirror of
https://github.com/bitinflow/localtunnel.git
synced 2026-03-15 22:45:54 +00:00
Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
afbdc3697e | ||
|
|
0049f21b55 | ||
|
|
509841104b | ||
|
|
92caf2f204 | ||
|
|
9487797e02 | ||
|
|
a42f6a8d8d | ||
|
|
14b4bcb96f | ||
|
|
4aa65002eb | ||
|
|
08676ba81d |
10
README.md
10
README.md
@@ -14,7 +14,7 @@ This will install the localtunnel module globally and add the 'lt' client cli to
|
|||||||
|
|
||||||
## use ##
|
## use ##
|
||||||
|
|
||||||
Super Easy! Assuming your local server is running on port 8000, just use the ```lt``` command to start the tunnel.
|
Assuming your local server is running on port 8000, just use the ```lt``` command to start the tunnel.
|
||||||
|
|
||||||
```
|
```
|
||||||
lt --port 8000
|
lt --port 8000
|
||||||
@@ -24,6 +24,13 @@ Thats it! It will connect to the tunnel server, setup the tunnel, and tell you w
|
|||||||
|
|
||||||
You can restart your local server all you want, ```lt``` is smart enough to detect this and reconnect once it is back.
|
You can restart your local server all you want, ```lt``` is smart enough to detect this and reconnect once it is back.
|
||||||
|
|
||||||
|
### arguments
|
||||||
|
|
||||||
|
Below are some common arguments. See `lt --help` for additional arguments
|
||||||
|
|
||||||
|
* `--subdomain` request a named subdomain on the localtunnel server (default is random characters)
|
||||||
|
* `--local-host` proxy to a hostname other than localhost
|
||||||
|
|
||||||
## API ##
|
## API ##
|
||||||
|
|
||||||
The localtunnel client is also usable through an API (for test integration, automation, etc)
|
The localtunnel client is also usable through an API (for test integration, automation, etc)
|
||||||
@@ -47,6 +54,7 @@ localtunnel(port, function(err, tunnel) {
|
|||||||
### opts
|
### opts
|
||||||
|
|
||||||
* `subdomain` A *string* value requesting a specific subdomain on the proxy server. **Note** You may not actually receive this name depending on availablily.
|
* `subdomain` A *string* value requesting a specific subdomain on the proxy server. **Note** You may not actually receive this name depending on availablily.
|
||||||
|
* `local_host` Proxy to this hostname instead of `localhost`. This will also cause the `Host` header to be re-written to this value in proxied requests.
|
||||||
|
|
||||||
### Tunnel
|
### Tunnel
|
||||||
|
|
||||||
|
|||||||
@@ -27,14 +27,13 @@ var opt = {
|
|||||||
|
|
||||||
lt_client(opt.port, opt, function(err, tunnel) {
|
lt_client(opt.port, opt, function(err, tunnel) {
|
||||||
if (err) {
|
if (err) {
|
||||||
console.error(err);
|
throw err;
|
||||||
return process.exit(1);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
console.log('your url is: %s', tunnel.url);
|
console.log('your url is: %s', tunnel.url);
|
||||||
|
|
||||||
tunnel.on('error', function(err) {
|
tunnel.on('error', function(err) {
|
||||||
console.error(err);
|
throw err;
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
58
client.js
58
client.js
@@ -5,6 +5,38 @@ var EventEmitter = require('events').EventEmitter;
|
|||||||
var request = require('request');
|
var request = require('request');
|
||||||
var debug = require('debug')('localtunnel:client');
|
var debug = require('debug')('localtunnel:client');
|
||||||
|
|
||||||
|
var stream = require('stream');
|
||||||
|
var util = require('util');
|
||||||
|
|
||||||
|
var Transform = stream.Transform;
|
||||||
|
|
||||||
|
var HeaderHostTransformer = function(opts) {
|
||||||
|
if (!(this instanceof HeaderHostTransformer)) {
|
||||||
|
return new HeaderHostTransformer(opts);
|
||||||
|
}
|
||||||
|
|
||||||
|
opts = opts || {}
|
||||||
|
Transform.call(this, opts);
|
||||||
|
|
||||||
|
var self = this;
|
||||||
|
self.host = opts.host || 'localhost';
|
||||||
|
self.replaced = false;
|
||||||
|
}
|
||||||
|
util.inherits(HeaderHostTransformer, Transform);
|
||||||
|
|
||||||
|
HeaderHostTransformer.prototype._transform = function (chunk, enc, cb) {
|
||||||
|
var self = this;
|
||||||
|
chunk = chunk.toString();
|
||||||
|
|
||||||
|
// after replacing the first instance of the Host header
|
||||||
|
// we just become a regular passthrough
|
||||||
|
self.push(chunk.replace(/(\r\nHost: )\S+/, function(match, $1) {
|
||||||
|
self._transform = undefined;
|
||||||
|
return $1 + self.host;
|
||||||
|
}));
|
||||||
|
cb();
|
||||||
|
};
|
||||||
|
|
||||||
// manages groups of tunnels
|
// manages groups of tunnels
|
||||||
var TunnelCluster = function(opt) {
|
var TunnelCluster = function(opt) {
|
||||||
if (!(this instanceof TunnelCluster)) {
|
if (!(this instanceof TunnelCluster)) {
|
||||||
@@ -55,13 +87,13 @@ TunnelCluster.prototype.open = function() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
function conn_local() {
|
function conn_local() {
|
||||||
debug('connecting locally to %s:%d', local_host, local_port);
|
|
||||||
|
|
||||||
if (remote.destroyed) {
|
if (remote.destroyed) {
|
||||||
|
debug('remote destroyed');
|
||||||
self.emit('dead');
|
self.emit('dead');
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
debug('connecting locally to %s:%d', local_host, local_port);
|
||||||
remote.pause();
|
remote.pause();
|
||||||
|
|
||||||
// connection to local http server
|
// connection to local http server
|
||||||
@@ -71,19 +103,24 @@ TunnelCluster.prototype.open = function() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
function remote_close() {
|
function remote_close() {
|
||||||
|
debug('remote close');
|
||||||
self.emit('dead');
|
self.emit('dead');
|
||||||
local.end();
|
local.end();
|
||||||
};
|
};
|
||||||
|
|
||||||
remote.once('close', remote_close);
|
remote.once('close', remote_close);
|
||||||
|
|
||||||
local.on('error', function(err) {
|
// TODO some languages have single threaded servers which makes opening up
|
||||||
|
// multiple local connections impossible. We need a smarter way to scale
|
||||||
|
// and adjust for such instances to avoid beating on the door of the server
|
||||||
|
local.once('error', function(err) {
|
||||||
|
debug('local error %s', err.message);
|
||||||
local.end();
|
local.end();
|
||||||
|
|
||||||
remote.removeListener('close', remote_close);
|
remote.removeListener('close', remote_close);
|
||||||
|
|
||||||
if (err.code !== 'ECONNREFUSED') {
|
if (err.code !== 'ECONNREFUSED') {
|
||||||
return local.emit('error', err);
|
return remove.end();
|
||||||
}
|
}
|
||||||
|
|
||||||
// retrying connection to local server
|
// retrying connection to local server
|
||||||
@@ -93,7 +130,16 @@ TunnelCluster.prototype.open = function() {
|
|||||||
local.once('connect', function() {
|
local.once('connect', function() {
|
||||||
debug('connected locally');
|
debug('connected locally');
|
||||||
remote.resume();
|
remote.resume();
|
||||||
remote.pipe(local).pipe(remote);
|
|
||||||
|
var stream = remote;
|
||||||
|
|
||||||
|
// if user requested something other than localhost
|
||||||
|
// then we use host header transform to replace the host header
|
||||||
|
if (local_host !== 'localhost') {
|
||||||
|
stream = remote.pipe(HeaderHostTransformer({ host: local_host }));
|
||||||
|
}
|
||||||
|
|
||||||
|
stream.pipe(local).pipe(remote);
|
||||||
|
|
||||||
// when local closes, also get a new remote
|
// when local closes, also get a new remote
|
||||||
local.once('close', function(had_error) {
|
local.once('close', function(had_error) {
|
||||||
@@ -105,8 +151,8 @@ TunnelCluster.prototype.open = function() {
|
|||||||
// tunnel is considered open when remote connects
|
// tunnel is considered open when remote connects
|
||||||
remote.once('connect', function() {
|
remote.once('connect', function() {
|
||||||
self.emit('open', remote);
|
self.emit('open', remote);
|
||||||
|
conn_local();
|
||||||
});
|
});
|
||||||
remote.once('connect', conn_local);
|
|
||||||
};
|
};
|
||||||
|
|
||||||
var Tunnel = function(opt) {
|
var Tunnel = function(opt) {
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"author": "Roman Shtylman <shtylman@gmail.com>",
|
"author": "Roman Shtylman <shtylman@gmail.com>",
|
||||||
"name": "localtunnel",
|
"name": "localtunnel",
|
||||||
"description": "expose localhost to the world",
|
"description": "expose localhost to the world",
|
||||||
"version": "1.0.0",
|
"version": "1.1.1",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git://github.com/shtylman/localtunnel.git"
|
"url": "git://github.com/shtylman/localtunnel.git"
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ var localtunnel = require('../');
|
|||||||
test('setup local http server', function(done) {
|
test('setup local http server', function(done) {
|
||||||
var server = http.createServer();
|
var server = http.createServer();
|
||||||
server.on('request', function(req, res) {
|
server.on('request', function(req, res) {
|
||||||
res.write('foo');
|
res.write(req.headers.host);
|
||||||
res.end();
|
res.end();
|
||||||
});
|
});
|
||||||
server.listen(function() {
|
server.listen(function() {
|
||||||
@@ -51,7 +51,7 @@ test('query localtunnel server w/ ident', function(done) {
|
|||||||
});
|
});
|
||||||
|
|
||||||
res.on('end', function() {
|
res.on('end', function() {
|
||||||
assert.equal('foo', body);
|
assert(/.*[.]localtunnel[.]me/.test(body), body);
|
||||||
done();
|
done();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -67,3 +67,47 @@ test('request specific domain', function(done) {
|
|||||||
done();
|
done();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
suite('local-host');
|
||||||
|
|
||||||
|
test('setup localtunnel client', function(done) {
|
||||||
|
var opt = {
|
||||||
|
local_host: '127.0.0.1'
|
||||||
|
};
|
||||||
|
localtunnel(test._fake_port, opt, function(err, tunnel) {
|
||||||
|
assert.ifError(err);
|
||||||
|
assert.ok(new RegExp('^https:\/\/.*localtunnel.me' + '$').test(tunnel.url));
|
||||||
|
test._fake_url = tunnel.url;
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test('override Host header with local-host', function(done) {
|
||||||
|
var uri = test._fake_url;
|
||||||
|
var parsed = url.parse(uri);
|
||||||
|
|
||||||
|
var opt = {
|
||||||
|
host: parsed.host,
|
||||||
|
port: 443,
|
||||||
|
headers: {
|
||||||
|
host: parsed.hostname
|
||||||
|
},
|
||||||
|
path: '/'
|
||||||
|
};
|
||||||
|
|
||||||
|
var req = https.request(opt, function(res) {
|
||||||
|
res.setEncoding('utf8');
|
||||||
|
var body = '';
|
||||||
|
|
||||||
|
res.on('data', function(chunk) {
|
||||||
|
body += chunk;
|
||||||
|
});
|
||||||
|
|
||||||
|
res.on('end', function() {
|
||||||
|
assert.equal(body, '127.0.0.1');
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
req.end();
|
||||||
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user