1.0.0 • Published 6 years ago

vazco-proxy v1.0.0

Weekly downloads
29
License
MIT
Repository
github
Last release
6 years ago

vazco-proxy

installation

npm install -g vazco-proxy

This will install the localtunnel module globally and add the 'vazco-proxy' client cli tool to your PATH.

use

Assuming your local server is running on port 8000, just use the vazco-proxy command to start the tunnel. Password to tun.vazco.eu you can find at https://pass.vazco.eu

vazco-proxy --port 8000 --password somePassword

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, vazco-proxy is smart enough to detect this and reconnect once it is back.

arguments

Below are some common arguments. See vazco-proxy --help for additional arguments

  • --subdomain request a named subdomain in tun.vazco.eu (default is random characters). So command like vazco-proxy --port 3000 --subdomain kotek will create tunnel from localhost:3000 to kotek.tun.vazco.eu
  • --local-host proxy to a hostname other than localhost

You may also specify arguments via env variables. E.x.

PORT=3000 PASSWORD=somePassword vazco-proxy

Tunnel

The tunnel instance returned to your callback emits the following events

eventargsdescription
requestinfofires when a request is processed by the tunnel, contains method and path fields
errorerrfires when an error happens on the tunnel
closefires when the tunnel has closed

The tunnel instance has the following methods

methodargsdescription
closeclose the tunnel

License

MIT