Getting Started

Quick Start

git clone https://github.com/CallMeTechie/gatecontrol.git
cd gatecontrol
cp .env.example .env
docker compose up -d

GateControl will then be available at your configured GC_BASE_URL.

Prerequisites

• Docker and Docker Compose
• A server with a public IP address or domain
• Port 51820/UDP (WireGuard), 80/TCP and 443/TCP (Caddy) open

Installation Options

Option 1: Online (recommended)

mkdir gatecontrol && cd gatecontrol
curl -fsSLO https://github.com/CallMeTechie/gatecontrol/releases/latest/download/setup.sh
curl -fsSLO https://github.com/CallMeTechie/gatecontrol/releases/latest/download/docker-compose.yml
curl -fsSLO https://github.com/CallMeTechie/gatecontrol/releases/latest/download/.env.example
sudo bash setup.sh

The setup script automatically detects your operating system, installs Docker if needed, and guides you through the configuration.

Option 2: Offline

curl -fsSLO https://github.com/CallMeTechie/gatecontrol/releases/download/v1.0.0/gatecontrol-image.tar.gz
curl -fsSLO https://github.com/CallMeTechie/gatecontrol/releases/download/v1.0.0/setup.sh
sudo bash setup.sh

Option 3: Docker Compose (manual)

git clone https://github.com/CallMeTechie/gatecontrol.git
cd gatecontrol
cp .env.example .env
# Edit .env
docker compose up -d

First Login

After starting, GateControl is available at the configured GC_BASE_URL (default: http://localhost:3000).

Default Credentials

Warning: The default password in .env.example is changeme. Change it before the first start! The setup script will ask you for a secure password — if installing manually, set it in your .env:

GC_ADMIN_USER=admin
GC_ADMIN_PASSWORD=YourSecurePassword123!

The username can be changed via GC_ADMIN_USER (default: admin).

After Login

1. Change password: Navigate to Profile (top right) and set a new password
2. Configure SMTP: Under Settings → Email for email notifications and Route Auth OTP
3. Create first peer: Under Peers → Add Peer