Install gotunnel

Choose your preferred installation method for your operating system

🍎 macOS Installation

Homebrew (Recommended)

The easiest way to install gotunnel on macOS

brew tap ferg-cod3s/gotunnel
brew install gotunnel

Install Script

Direct installation using our install script

curl -sSL https://raw.githubusercontent.com/johncferguson/gotunnel/main/scripts/install.sh | bash

Go Install

If you have Go installed

go install github.com/johncferguson/gotunnel/cmd/gotunnel@latest

🐧 Linux Installation

APT (Debian/Ubuntu)

For Debian-based distributions

curl -fsSL https://github.com/johncferguson/gotunnel/releases/latest/download/gotunnel_0.1.0-beta_amd64.deb -o gotunnel.deb
sudo dpkg -i gotunnel.deb

AUR (Arch Linux)

For Arch Linux users

yay -S gotunnel
# or: paru -S gotunnel

Install Script

Universal installation script for Linux

curl -sSL https://raw.githubusercontent.com/johncferguson/gotunnel/main/scripts/install.sh | bash

🪟 Windows Installation

Scoop (Recommended)

Easy package management for Windows

scoop bucket add ferg-cod3s https://github.com/ferg-cod3s/scoop-bucket
scoop install gotunnel

Winget

Windows Package Manager

winget install johncferguson.gotunnel

Chocolatey

Popular Windows package manager

choco install gotunnel

🐳 Docker Installation

Docker Run

Quick start with Docker

docker run --rm -p 80:80 -p 443:443 ghcr.io/johncferguson/gotunnel:latest

Docker Compose

Production deployment with Docker Compose

version: '3.8'
services:
  gotunnel:
    image: ghcr.io/johncferguson/gotunnel:latest
    ports:
      - "80:80"
      - "443:443"
    environment:
      - ENVIRONMENT=production
      - SENTRY_DSN=YOUR_SENTRY_DSN_HERE
    restart: unless-stopped

✅ Verify Installation

After installation, verify that gotunnel is working correctly:

Check Version

gotunnel --version

Quick Test

Start a simple tunnel (no root privileges required):

gotunnel --proxy=builtin --no-privilege-check start \
  --port 3000 --domain test --https=false