Home

Gluetun Companion

Gluetun Companion is a Web UI for controlling an existing Gluetun container: server catalogue, benchmarks, automatic or manual switches, dependent-container management, port forwarding, BitTorrent tracker checks and Prometheus metrics.

Status: beta. The project is primarily tested with AirVPN. Other providers use the same mechanics, but should be validated in real-world conditions.

Quick start

1. Expose Gluetun’s HTTP proxy on the host.
2. Mount the directory containing Gluetun’s Compose file into Companion.
3. Start ghcr.io/aerya/gluetun-companion:latest.
4. Open the UI on port 8765 and import the servers.

See Installation-en for the complete Compose example and Configuration-en for the available variables.

Features

• WireGuard and OpenVPN, with separate VPN profiles and credentials.
• Sidecar benchmarks without restarting the main Gluetun during testing.
• HTTP proxy mode for quick checks.
• Automatic selection based on throughput, latency, jitter, packet loss and history.
• Rotation pools, failover and intelligent selection for large catalogues.
• Tracker discovery from qBittorrent or rTorrent/ruTorrent.
• Per-URL control, with Check all and Uncheck all actions.
• Provider, native Gluetun or custom port forwarding.
• Discord/Apprise notifications, REST API, Prometheus metrics and Grafana dashboard.

Documentation

This Wiki follows the main topics of README.md and README.en.md. The repository README files are intentionally unchanged for now.