mirror of
https://github.com/bitinflow/server.git
synced 2026-03-13 13:35:53 +00:00
2f692b8e29
- Allows for using localtunnel from code instead of manually invoking - add tests - add travis config - add travis badge
49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
# localtunnel [](http://travis-ci.org/shtylman/localtunnel) #
|
|
|
|
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.
|
|
|
|
Great for working with browser testing tools like browserling or external api callback services like twilio which require a public url for callbacks!
|
|
|
|
## installation ##
|
|
|
|
```
|
|
npm install -g localtunnel
|
|
```
|
|
|
|
## use ##
|
|
|
|
Super East! Assuming your local server is running on port 8000, just use the ```lt``` command to start the tunnel.
|
|
|
|
```
|
|
lt --port 8000
|
|
```
|
|
|
|
Thats it! It will connect to the tunnel server, setup the tunnel, and tell you what url to use for your testing. This url will remain active for the duration of your session; so feel free to share it with others for happy fun time!
|
|
|
|
You can restart your local server all you want, ```lt``` is smart enough to detect this and reconnect once it is back.
|
|
|
|
## API ##
|
|
|
|
The localtunnel client is also usable through an API (test integration, automation, etc)
|
|
|
|
```javascript
|
|
var lt_client = require('localtunnel').client;
|
|
|
|
var client = lt_client.connect({
|
|
// the localtunnel server
|
|
host: 'http://localtunnel.com',
|
|
// your local application port
|
|
port: 12345
|
|
});
|
|
|
|
// when your are assigned a url
|
|
client.on('url', function(url) {
|
|
// you can now make http requests to the url
|
|
// they will be proxied to your local server on port [12345]
|
|
});
|
|
|
|
client.on('error', function(err) {
|
|
// uh oh!
|
|
});
|
|
```
|