Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2.35 KB

File metadata and controls

58 lines (38 loc) · 2.35 KB

Freetunnel Server

Create secure introspectable tunnels to your local device with a single command.


OverviewUsageSetup Your Own Freetunnel Server


Overview

Freetunnel is a tool for creating tunnels from your local development machine to a public and secure URL. This allows for easy webhook development, sharing of demo applications across networks, and using tools such as PageSpeed Insights which require public acess.

Freetunnel comes in two parts: a CLI tool and a server. You use the CLI tool to connect to a server host, making your localhost accessible, and the server can be ran if you want your own configurable instance of Freetunnel. While I host an instance at https://freetunnel.ryanchristian.dev, you might not want to use that URL, and slots are limited. To ensure my infrastructure is never too burdened, there can only be 5 sites using that instance at one without the server password.

Usage

I host an instance of the server at https://freetunnel.ryanchristian.dev. However, availability of this is not guaranteed and service may go down without warning. See Setup if that is a concern.

Setup Your Own Freetunnel Server

If you'd like to run your own instance of Freetunnel, maybe because you dislike the domain or the free slots are full (I only provide 5 slots for free on a first-come first-served basis), you're easily able to with a Docker container I've set up. Simply run the following to start up your own instance:

$ docker run -d \
  -p 5000:5000 \
  ryanchristian4427/freetunnel

You have a few options to customize using environment variables, if you'd like:

FREETUNNEL_PORT (default 5000)

FREETUNNEL_PASSWORD (default undefined)

FREETUNNEL_MAX_FREE_SUBDOMAINS (default 5)

To configure these with Docker, use the following:

$ docker run -d \
  -p 3000:6000 \
  -e FREETUNNEL_PORT=6000 \
  -e FREETUNNEL_PASSWORD=my_password \
  -e FREETUNNEL_MAX_FREE_SUBDOMAINS=5 \
  ryanchristian4427/freetunnel

License

MIT