quickportal v0.0.4

quickportal

quickportal 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.

quickstart

npx quickportal --port 8000

installation

globally

npm install -g quickportal

project dependency

npm add quickportal

cli

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

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

arguments

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

• --subdomain request a named subdomain on the quicknexus (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 quip

API

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

quickportal(port ,options)

Creates a new tunnel to the specified local port. Will return a Promise that resolves once you have been assigned a public quickportal 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.

import quickportal from "quickportal";

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

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

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

options

• port (number) required The local port number to expose through quickportal.
• subdomain (string) required Request a specific subdomain on the proxy server. Note You may not actually receive this name depending on availability.
• host (string) URL for the upstream proxy server. Defaults to https://localtunnel.me.
• local_alias (string) Proxy to this hostname instead of localhost. Usually can be either 0.0.0.0 or 127.0.0.1. 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

The tunnel instance has the following methods

server

See BURG3R5/quicknexus for details on the server that powers quickportal.

license

MIT