bitinflow/localtunnel
1
0
Fork 0
mirror of https://github.com/bitinflow/localtunnel.git synced 2026-03-19 00:15:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

document local-host option

Browse Source
This commit is contained in:
Roman Shtylman
2014-02-24 19:49:40 -05:00
parent 14b4bcb96f
commit a42f6a8d8d
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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