tunnelify

A simple tool that exposes static folders from your local machine to the web

Table of Contents

• Features
• Install
• Usage
  • Command Line
  • From another application
• Use a Custom Remote Domain
• Examples
• Contributing

Features

Released

• Expose a local directory to an HTTP port
• Create a remotely accesible url
• Expose your local tunnelify server on the remote url
• Create your custom remote tunnel provider

WIP

• Public, Free and Predefined provider https://tnlfy.live
• More sophisticated Tunnel management for the Provider
• Better provider configuration for a more customizable experience

Install

With npm, for global usage:

$ npm install -g @mikesposito/tunnelify

With npm, for usage in another project:

$ npm install --save @mikesposito/tunnelify

# OR FOR DEVELOPMENT ONLY:
$ npm install --save-dev @mikesposito/tunnelify

Usage

With Command Line

Tunnelify only requires an absolute or relative path of the directory containing files you want to expose:

$ tunnelify <PATH>

Custom Port

You can use -p <PORT> to use a custom port number for the local server:

$ tunnelify -p <PORT> <PATH>

Custom Provider

You can use -r <REMOTE_PROVIDER_URL> to use a different Tunnelify Provider other than the public, free and default https://tnlfy.live

$ tunnelify -r <REMOTE_PROVIDER_URL> <PATH>

From another application

Tunnelify can also be used from other javascript applications. You can use the main Tunnelify class to instantiate a tunnel:

const tunnelify = new Tunnelify({
  src: "/path/to/files",
  flags: {
    remote: `https://tnlfy.live`, 
    port: 32000,
    silent: false | true,
    verbose: false | true
  }
});

tunnelify.run();

Examples

Minimal:

$ tunnelify ./my-folder

With custom port:

$ tunnelify -p 3000 ./my-folder

With custom Tunnelify Provider:

$ tunnelify -r https://my-domain.com

Use a Custom Remote Domain

You can create you own remote Tunnelify Provider to expose files on your private domains.

1. Install Tunnelify Provider

$ npm install -g @mikesposito/tunnelify-provider

2. Run Tunnelify Provider

$ tunnelify-provider -h <HOSTNAME>

Where <HOSTNAME> should be your domain.

Example:

$ tunnelify-provider -h my-domain.com

By default, tunnelify-provider will listen on port 9410, but you can shoose a different port with -p:

$ tunnelify-provider -h my-domain.com -p 8080

Contributing

Every contribute is well accepted and the main goal of the project is to provide a solid software.

PRs are welcome and we are writing down some guidelines and code of conducts along with core code and documentation.

We hope to provode a comphensive documentation as we go through the first release we'll do as we reach a first releasable version v0.1