Skip to content
Aerya edited this page Jul 15, 2026 · 4 revisions

Gluetun Companion

🇫🇷 Version française

Gluetun Companion

Related article — Overview and illustrated walkthrough (with UI screenshots) on the blog: Gluetun Companion: web interface to automatically pilot your WireGuard and OpenVPN VPN servers in Gluetun (in French).

Build Trivy CVE scan Dependabot Docker arch i18n Gluetun compatible AirVPN Proton compatible Unraid DockerMan Discord Apprise Docker socket-proxy

Using it? Liking it? ⭐ Drop a star! — takes two seconds.

Want the shortest path? Check compatibility, go directly to the quick start, then return to features and detailed operation as needed. Project maintenance is covered under automated workflows and security.

Gluetun Companion is a Web UI for automatically managing WireGuard and OpenVPN servers inside Gluetun:

  • It benchmarks your VPN servers from inside the tunnel itself, using sidecar mode without restarting your main Gluetun, or Gluetun’s HTTP proxy
  • Each server is evaluated using speed, latency, jitter, packet loss, DNS latency, history and real-world stability
  • The best server can be selected automatically according to your usage profile: balanced, gaming, BitTorrent, DDL, download or streaming
  • Rotation pools also let you switch servers without a full benchmark, using random, round-robin or best historical download selection
  • VPN profiles support multiple providers, protocols and custom configurations, with encrypted secrets and WireGuard/OpenVPN support
  • The Gluetun catalogue, AirVPN picker, new-server detection and overloaded-server filtering make daily maintenance easier
  • Companion manages Docker containers attached to Gluetun: recreation after switches, pause during benchmarks and optional image updates
  • It can check BitTorrent trackers, handle VPN port forwarding and synchronize ports with qBittorrent or rTorrent
  • History, hourly patterns, Discord/Apprise notifications, REST API, Prometheus metrics and Grafana support turn it into a full homelab VPN control panel

Status: beta. Gluetun Companion is still in testing. It is developed and battle-tested primarily with AirVPN; other providers have barely been tested in real conditions, even though the mechanics (catalogue, benchmark, switching, container management) are strictly identical for all of them. Your feedback is invaluable.

Current validation status:

  • 100% functional with AirVPN over WireGuard;
  • tested over WireGuard with a few other providers;
  • feedback needed for OpenVPN providers;
  • ProtonVPN WireGuard + NAT-PMP port forwarding supported through VPN profiles; real-world qBittorrent synchronization feedback is still useful;
  • feedback needed for Custom WireGuard and Custom OpenVPN servers.

AI-assisted development: approximately 70% of the code was produced with the assistance of Claude Code and Codex, under human direction and validation. Particular attention is paid to security: secret encryption and protection, automated workflows, Dependabot and Trivy, restricted Docker socket access through docker-socket-proxy, automated tests, and change review. This transparency does not replace real-world feedback, which remains especially important during beta testing.

Issues and pull requests are welcome, with proper form: for an issue, please include the version, VPN provider, relevant logs and reproduction steps; for a PR, a clear description of the problem solved and the expected behaviour.


Documentation

Gluetun Companion

Français

English


🇫🇷 Français · 🇬🇧 English

Clone this wiki locally