Cutlery/homepage
1
0
Fork 0
mirror of https://github.com/gethomepage/homepage.git synced 2025-07-08 18:54:20 -04:00
Code Issues Packages Projects Releases Wiki Activity
homepage/docs/widgets/services/gluetun.md

1.0 KiB
Raw Permalink Blame History

title, description
title description
Gluetun Gluetun Widget Configuration

Learn more about Gluetun.

!!! note

Requires [HTTP control server options](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md) to be enabled. By default this runs on port `8000`.

Allowed fields: ["public_ip", "region", "country", "port_forwarded"]. Default fields: ["public_ip", "region", "country"].

To setup authentication, follow the official Gluetun documentation. Note that to use the api key method, you must add the route GET /v1/publicip/ip to the routes array in your Gluetun config.toml. Similarly, if you want to include the port_forwarded field, you must add the route GET /v1/openvpn/portforwarded to your Gluetun config.toml.

widget:
  type: gluetun
  url: http://gluetun.host.or.ip:port
  key: gluetunkey # Not required if /v1/publicip/ip endpoint is configured with `auth = none`