This is a Home Assistant custom integration that reads VPN status information from a Gluetun instance via its HTTP Control Server. It exposes sensors for:
- Public IP address from
/v1/publicip/ip - Country from
/v1/publicip/ip - City from
/v1/publicip/ip - Location from
/v1/publicip/ip - Organization from
/v1/publicip/ip - Postal Code from
/v1/publicip/ip - Public Ip from
/v1/publicip/ip - Region from
/v1/publicip/ip - Status from
/v1/openvpn/status - Timezone from
/v1/publicip/ip
Ensure Gluetun’s HTTP Control Server is enabled and reachable from Home Assistant. (These endpoints reflect the project’s existing behavior.)
- In Home Assistant, open HACS → Integrations.
- Click ⋯ (three dots) → Custom repositories.
- Paste
https://github.com/madcowGit/gluetun_ccand select Type: Integration, then click Add. - Back in HACS, search for Gluetun (custom component) and click Install.
- Restart Home Assistant when prompted.
Copy the custom_components/gluetun_cc/ directory into your HA config/custom_components/ and restart.
- A running Gluetun with the HTTP Control Server enabled and accessible (e.g.,
http://<gluetun-host>:8000).
- Go to Settings → Devices & services → Add integration and search for Gluetun (custom component).
- Enter the HTTP Control Server details.
- Finish the flow; entities for VPN status, public IP, and country (if available) will be created.
- Thanks to qdm12 for the Gluetun project.