Docs
Commands
Introduction

btunnel

btunnel client cli tool

Synopsis

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

The key features of btunnel are:

  • high performance
  • build-in file server
  • basic auth capability
  • always https urls
  • geo-location based url
  • web gui for request monitoring and analysis

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

btunnel --help

Output of the above command is like this -

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
  -l, --log string       Path to log file, by default it doesn't write to any file
  -m, --monitor string   Wheather to start the web monitor interface (default "true")
  -q, --quiet string     If true, doesn't print the http logs (default "false")
  -r, --region string    Region options, ap (Singapore), in (India), eu (Europe) and us (Usa Virginia)
  -v, --version          version for btunnel

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

Note

btunnel command itself will do nothing unless invoked with either http, file or tcp subcommand

SEE ALSO