Gluetun Companion
Gluetun Companion is a self-hosted web UI that manages an existing Gluetun VPN container from the browser.
Platform availability
Available on 1 of 10 platforms
- Unraid
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server (not listed)
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
69/100 Good
- Maintained
- 100last commit 7 days ago
- Popular
- 2415 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- No data
- Security check
- 95no serious findings, CI, tests
Based on 4 of 5 factors.
Availability: platform listings confirmed today, links checked 22 days ago
- GitHub stars
- 15
- Open issues
- 0
- Last commit
- 2026-11-14
- Activity
- steady
Checked 7 days ago - source: GitHub (Aerya/Gluetun-Companion)
Resources & Compatibility
Requirements not published yet.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Give the container VPN permissions In your Docker Compose file, add the NET_ADMIN network permission and map the /dev/net/tun device. This lets the container make a private VPN tunnel, and without it the VPN will fail to connect. source
- Set your VPN provider and login Before starting, set VPN_SERVICE_PROVIDER and enter your provider's credentials, such as an OpenVPN username/password or a WireGuard key and address. If these are missing or wrong, Gluetun can't log in to your VPN. source
- Choose where the VPN connects Use SERVER_COUNTRIES or SERVER_CITIES to pick a VPN location you actually want to use. If you leave it unset, Gluetun may pick a server for you, which can give you a slower or unexpected internet location. source
- Unraid permissions On Unraid this template targets DockerMan-managed Gluetun containers. The companion needs read/write access to /boot/config/plugins/dockerMan/templates-user so server switches persist in the template XML, and the Docker socket to inspect/recreate Gluetun and its network dependents. It intentionally runs as root because DockerMan templates are root-owned. source
- Secret key Set SECRET_KEY to a long random value before first start and keep it forever; changing it later invalidates the companion's saved configuration. source
Fetched 47 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
What special setup does the Unraid template require?
It intentionally runs as root and needs read/write access to /boot/config/plugins/dockerMan/templates-user. This is required because DockerMan templates are root-owned and mode 600, and PUID/PGID would break template write-back unless host permissions are changed manually.
Why does the companion need access to the Docker socket?
It uses the Docker socket to inspect and recreate the Gluetun container. It also needs it to manage running network dependents.
Can the companion benchmark VPN servers without restarting Gluetun?
Yes, it can benchmark from the VPN tunnel itself in sidecar mode without restarting Gluetun. It can also use the integrated HTTP proxy and measures throughput, latency, jitter, packet loss, DNS, history, and stability.
Can it rotate servers without running benchmarks?
Yes, rotation pools can change servers randomly, round-robin, or by best historical speed. This works without benchmarking.
Answers sourced from github.com
Community
- Gluetun (VPN for a few containers) Alternative? : r/selfhosted - Reddit (reddit)
- Need replacement for gluetun docker for wireguard VPN (reddit)
Collected 49 days ago - public community threads