Install the tunnel

The quick way

In the console, open Settings › Tunnels and choose Add tunnel. You get one command with a one-time token in it, valid for a day. Run it on a machine inside your network:

s="$(curl --proto '=https' -fsSL https://get.flowplane.eu/tunnel/install.sh)" && \
  printf '%s' 'fpt_…' | sudo sh -c "$s" sh -v v1.2.3 -s -c https://api.flowplane.eu -a 10.0.0.0/24 -a nas.lan:5000

Copy the command from the console rather than from this page: it has your token, the current version and your allow list filled in.

The script downloads the tunnel, checks it against the published checksums, enrols it and, with -s, installs it as a service. It runs as root, so read it first if you want to: curl https://get.flowplane.eu/tunnel/install.sh.

Options

Option
-v VERSION	Install this version, for example v1.2.3.
-s	Install and start a service.
-c URL	The console API to enrol at.
-a ENTRY	One allow list entry. Repeat it.
-d DIR	Install the binary into DIR instead of /usr/local/bin.

Platforms

OS	Architectures
Linux	amd64, arm64, armv7
macOS	arm64, amd64

On Linux the tunnel runs as a systemd service, flowplane-tunnel.service. On macOS it runs as a LaunchDaemon, eu.flowplane.tunnel.

Windows, Docker and Kubernetes are coming. The console lists them as soon as they are available.

Download by hand

Every release is at https://get.flowplane.eu/tunnel/<version>/, with a SHA256SUMS file. latest points to the newest release.

v=v1.2.3; os=linux; arch=amd64
base=https://get.flowplane.eu/tunnel/$v
f="flowplane-tunnel_${v}_${os}_${arch}"
curl -fsSLO "$base/SHA256SUMS" -O "$base/$f"
grep " $f\$" SHA256SUMS | sha256sum -c -        # macOS: shasum -a 256 -c -
install -m 0755 "$f" /usr/local/bin/flowplane-tunnel
flowplane-tunnel version

Then enrol and run it.