installation

get started with funnel by installing the client and running the server using docker.

client installation

the easiest way to install the funnel client:

curl -LsSf https://raw.githubusercontent.com/karol-broda/funnel/master/scripts/install.sh | sh

supports linux and macos on both amd64 and arm64 architectures.

download from the releases page and install:

# example for linux amd64
sudo mv funnel /usr/local/bin/funnel
sudo chmod +x /usr/local/bin/funnel

requires go 1.21 or later:

git clone https://github.com/karol-broda/funnel.git
cd funnel
make build-client
sudo mv ./bin/funnel /usr/local/bin/funnel

server installation

docker required

the server runs as a docker container. you'll need docker installed.

using docker image

# pull and verify the server image
docker pull ghcr.io/karol-broda/funnel-server:latest
docker run --rm ghcr.io/karol-broda/funnel-server:latest version

building from source

git clone https://github.com/karol-broda/funnel.git
cd funnel
make build-server-docker

project structure

client.go

connection.go

runner.go

server.go

router.go

tunnel.go

main.go

next steps

basic usage - create your first tunnel
server deployment - deploy for production
cli reference - explore all commands

Last updated: July 18, 2025

by karol-broda