https://github.com/patmigliaccio/tnl

A simple secure tunnel to a local directory using ngrok and http-server
https://github.com/patmigliaccio/tnl

Last synced: 26 days ago
JSON representation

A simple secure tunnel to a local directory using ngrok and http-server

• Host: GitHub
• URL: https://github.com/patmigliaccio/tnl
• Owner: patmigliaccio
• License: mit
• Created: 2017-03-16T21:32:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-09T21:39:16.000Z (over 6 years ago)
• Last Synced: 2024-10-11T04:33:49.413Z (28 days ago)
• Language: JavaScript
• Homepage:
• Size: 42 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![build status](https://img.shields.io/travis/patmigliaccio/tnl.svg?style=flat-square)](https://travis-ci.org/patmigliaccio/tnl)

[![npm](https://img.shields.io/npm/v/tnl.svg?style=flat-square)](https://www.npmjs.com/package/tnl)

[![license](https://img.shields.io/github/license/patmigliaccio/tnl.svg?style=flat-square)](https://github.com/patmigliaccio/tnl)

# tnl: simple secure tunnel to a local directory

`tnl` is a quick and easy way to create a public url with a secure tunnel to a local directory. Utilizing [ngrok](https://ngrok.com/) and [http-server](https://github.com/indexzero/http-server), within three characters you can have your directory forwarded to the outside. Excellent for testing on mobile as well as fast feedback from clients.

![tnl Example](img/example.gif)

## Installation

Using `yarn`:

    yarn global add tnl

-- or --

Using `npm`:

     npm install tnl -g

It is now installed globally and `tnl` can be used in any directory from the command line.

## Usage

     tnl [path] [options]

By default `[path]` and `[options]` are *optional*.

For example, to change the default port and open immediately in a new browser window:

    tnl -p 7001 -o

### Path

Location of the local directory to be served. Defaults to `./public` if the folder exists otherwise uses the root `./` directory.

### Options

For a complete list of *potential* options refer to `http-server`'s [avalable options](https://www.npmjs.com/package/http-server#available-options).

`-o` Open browser window after starting the server and tunnel

`-n` or `--ncopy` Copy the ngrok URL to the clipboard for pasting

`-p` Port to use (defaults to `8080`)

`-a` Address to use (defaults to `'0.0.0.0'`)

`-d` Show directory listings (defaults to `true`)

`-i` Display autoIndex (defaults to `true`)

`-e` or `--ext` Default file extension if none supplied (defaults to `'html'`)

`-s` or `--silent` Suppress log messages from output

`--cors` Enable CORS via the Access-Control-Allow-Origin header

`-c` Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds (defaults to `3600`). To disable caching, use `-c-1`.

`-P` or `--proxy` Proxies all requests which can't be resolved locally to the given url. e.g.: `-P`

## API

    var tnl = require('tnl');

See [API documentation](docs/API.md).