Installation

Getting started

Prerequisites

Install btunnel by running the following command in your terminal. For Linux and Mac -

curl -L https://www.btunnel.in/install.sh | sh

For Windows -

pwsh -Command "iwr https://www.btunnel.in/install.ps1 -useb | iex"

Then open a new terminal (Linux and Mac) or cmd prompt (Windows), to run btunnel.

Then you need to register/login at btunnel website to get an unique API_KEY which you will require to authenticate the cli-tool. We suggest you to store your API_KEY in some environment variable like BTUNNEL_API_KEY (and put it in .bashrc or .zshrc in *Nix system) for security purpose and use it like this :

btunnel http -key $BTUNNEL_API_KEY --port 3000

Getting btunnel client

Go to btunnel (opens in a new tab) website and download the cli-tool btunnel for your os flavor. Then extract the .tar.gz or .zip file to get the executable binary. Go to the directory through terminal (*Nix) or cmd (Windows) using cd command where the btunnel binary is extracted.

To get an overview of the subcommands, run the following

For *Nix (Mac and Linux)

$ ./btunnel --help

For Windows

C:\Users\user\Desktop\btunnel-dir> btunnel --help

Output

btunnel is a http reverse proxy to expose your localhost to the internet.

The key features of btunnel are:
  1. build-in file server
  2. basic auth capability
  3. always https urls
  4. build in file-server

To run this you need an api key.
Sign-up at https://www.btunnel.in to get your own api key and keep this private.

Examples:
  btunnel http --key <API_KEY> --port 3000                        # expose public url for port 3000 http server
  btunnel http --key <API_KEY> --port 3000 --auth user:password   # protect with basic auth
  btunnel file --key <API_KEY> --dir /my/directory                # expose public url for given directory path

Usage:
  btunnel [flags]
  btunnel [command]

Available Commands:
  domain      Domain related commands
  file        Serve local directory
  help        Help about any command
  http        Serve localhost http server
  tcp         Expose any tcp server to the internet

Flags:
  -c, --config string   config file (default is $HOME/.btunnel.yaml)
  -h, --help            help for btunnel
  -k, --key string      API Key to use btunnel, sign-up at https://www.btunnel.in to get your own
      --region string   Region options, ap (Singapore), in (India), eu (Europe) and us (Usa Virginia)

Use "btunnel [command] --help" for more information about a command.