How qdm12/gluetun works
Gluetun is a VPN client that configures a protected network environment, connects through many VPN providers, and offers supporting DNS, proxy, port-forwarding, and operational services. The main executable reads settings and sets up routing and firewalling; provider-specific modules and VPN implementations supply the connection choices. The README documents additional capabilities whose detailed wiring is not shown in the excerpts, so those links are documented at the subsystem level. Source excerpts show only part of startup, so unspecified runtime relationships are omitted.
Main entry points: main.go Application startup · tunnelup.go VPN lifecycle · providers.go VPN providers · storage.go Server catalog
Components 22
Startup and settings
- Application startup
cmd/gluetun/main.go - Settings
internal/configuration/settings/settings.go - File configuration
internal/configuration/sources/files/reader.go
VPN connection
- VPN providers
internal/provider/providers.go - Server catalog
internal/storage/storage.go - Server records
internal/models/server.go - VPN lifecycle
internal/vpn/tunnelup.go - OpenVPN
internal/openvpn/openvpn.go - WireGuard
internal/wireguard/run.go - AmneziaWG
internal/amneziawg/run.go
Network protection
- Network routing
internal/routing/routing.go - Kill-switch firewall
internal/firewall/iptables/iptables.go
Runtime services
- DNS and filtering
internal/dns/run.go - Port forwarding
internal/portforward/loop.go - SOCKS5 proxy
internal/socks5/server.go - HTTP proxy
internal/httpproxy/server.go - Shadowsocks proxy
internal/shadowsocks/loop.go - Health checks
internal/healthcheck/server.go - Prometheus metrics
internal/metrics/prometheus/server.go - Control API
internal/server/server.go - Public IP lookup
internal/publicip/loop.go
Other components
- Operator
Connections 23
- Operator → Application startup: starts
- Application startup → Settings: reads
cmd/gluetun/main.go - Application startup → File configuration: configures reader
cmd/gluetun/main.go - Application startup → Network routing: sets up
cmd/gluetun/main.go - Application startup → Kill-switch firewall: configures
cmd/gluetun/main.go - Application startup → Port forwarding: starts
cmd/gluetun/main.go - Application startup → SOCKS5 proxy: starts
cmd/gluetun/main.go - Application startup → Health checks: starts
cmd/gluetun/main.go - Application startup → Prometheus metrics: starts
cmd/gluetun/main.go - Application startup → Control API: creates
cmd/gluetun/main.go - Application startup → VPN providers: initializes
cmd/gluetun/main.go - VPN providers → Server catalog: uses
- Server catalog → Server records: stores
internal/storage/storage.go - VPN providers → VPN lifecycle: selects connection
- VPN lifecycle → OpenVPN: supports
- VPN lifecycle → WireGuard: supports
- VPN lifecycle → AmneziaWG: supports
- Application startup → DNS and filtering: runs
- Application startup → HTTP proxy: runs
- Application startup → Shadowsocks proxy: runs
- Application startup → Public IP lookup: runs
- VPN lifecycle → Port forwarding: enables
- Application startup → Kill-switch firewall: protects traffic