pjvds / tunl

Instantly expose local services to the internet

Tunl

With Tunl you can expose services on your localhost to the public via a fast and secure tunnel.

Expose local http process

$ tunl http localhost:3000
https://red-fox.tunl.es/ -> http://localhost:3000

Share a local directory

$ tunl files /dir
https://red-fox.tunl.es/ -> /dir

Expose a local MySQL

$ tunl tcp localhost:3306
tunl.es:89311 -> localhost:3306

Expose a service running in a docker container

$ tunl docker [container-name]:<port>
tunl.es:48221 -> <container-name>:<port>

Installation

Download the binary release and put it somewhere in your $PATH.

Basic

curl

# install it to ./bin/tunl
curl -fsSL https://get.tunl.es | sh

# install it to /sbin/tunl
curl -fsSL https://get.tunl.es | sudo sh -s -- -b /sbin

wget

# install it to ./bin/tunl
wget -qO- https://get.tunl.es | sh

# install it to /sbin/tunl
wget -qO- https://get.tunl.es | sudo sh -s -- -b /sbin

Arch Linux

yay tunl

Ubuntu

sudo snap install tunl --edge

Docker

docker run --rm --network=host -v $PWD:$PWD tunl/tunl

warning: this maps the current working directory and means files outside the current working directory cannot be shared

tunl's Issues

cannot load embed: malformed module path "embed": missing dot in first path element

So I just cloned the repo and tried the "go get ./..." inside the cmd folder.

But I got:

build github.com/pjvds/tunl/cmd: cannot load embed: malformed module path "embed": missing dot in first path element.

I'm new to go, how can I setup the workspace to start contributing to the project?

please help me i am facing this error

while run this command tunl http localhost:3000
getting error as" Failed to connect to host _.tunl.es:443: dial tcp: lookup _.tunl.es on [::1]:53: dial udp [::1]:53: socket: permission denied"

files doesn't validate specified path

You can create a file tunnel to a non existing path:

$ tunl files /i/do/not/exist
https://lively-smoke.tunl.es -> /i/do/not/exist

The path should be validated before the tunnel is created.

HTTP should set Forwarded request header

The Forwarded header contains information from the reverse proxy that is altered of lost when a proxy is involved in the path of the request.

This header is not only used for debugging and statistics, but also for generating location-dependent content.

See: https://tools.ietf.org/html/rfc7239#section-4

x509: certificate is valid for smoovall.be, www.smoovall.be, not _.tunl.es

When I run

$ go run ./cmd/main.go http localhost:1313

I get this error message:

tunl server connection failed: server dial failed: tls: failed to verify certificate: x509: certificate is valid for smoovall.be, www.smoovall.be, not _.tunl.es