README

anttunnel

anttunnel exposes your localhost to the world for easy testing and sharing!

Installation

Globally

npm install -g @anttunnel/anttunnel

As a dependency in your project

yarn add @anttunnel/anttunnel

npm install --save @anttunnel/anttunnel

CLI usage

When anttunnel is installed globally, just use the anttunnel command to start the tunnel.

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

Arguments

Below are some common arguments. See anttunnel --help for additional arguments

--subdomain request a named subdomain on the anttunnel server (default is random characters)
--local-host proxy to a hostname other than localhost

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

PORT=3000 anttunnel

API

The anttunnel client is also usable through an API (for test integration, automation, etc)

anttunnel(port [,options][,callback])

Creates a new anttunnel to the specified local port. Will return a Promise that resolves once you have been assigned a public anttunnel url. options can be used to request a specific subdomain. A callback function can be passed, in which case it won't return a Promise. This exists for backwards compatibility with the old Node-style callback API. You may also pass a single options object with port as a property.

const anttunnel = require('anttunnel/anttunnel');

(async () => {
  const tunnel = await anttunnel({ port: 3000 });

  // the assigned public url for your tunnel
  // i.e. https://abcdefgjhij.anttunnel.me
  tunnel.url;

  tunnel.on('close', () => {
    // tunnels are closed
  });
})();

options

port (number) [required] The local port number to expose through anttunnel.
subdomain (string) Request a specific subdomain on the proxy server. Note You may not actually receive this name depending on availability.
domain (string) Request a domain, Options: ant-tunnel.com(default), anttunnel.com, opentun.nl, gametun.nl, webtun.nl
region (string) Region for the tunnel, Options - SFO (default), FRA, BLR, NYC
local_host (string) Proxy to this hostname instead of localhost. This will also cause the Host header to be re-written to this value in proxied requests.
local_https (boolean) Enable tunneling to local HTTPS server.
local_cert (string) Path to certificate PEM file for local HTTPS server.
local_key (string) Path to certificate key file for local HTTPS server.
local_ca (string) Path to certificate authority file for self-signed certificates.
allow_invalid_cert (boolean) Disable certificate checks for your local HTTPS server (ignore cert/key/ca options).

Refer to tls.createSecureContext for details on the certificate options.

Tunnel

The tunnel instance returned to your callback emits the following events

event	args	description
request	info	fires when a request is processed by the tunnel, contains method and path fields
error	err	fires when an error happens on the tunnel
close		fires when the tunnel has closed

The tunnel instance has the following methods

method	args	description
close		close the tunnel

License

MIT

Usage no npm install needed!