arriej/homepage-Mirror
1
0
Fork 0
mirror of https://github.com/gethomepage/homepage.git synced 2025-12-05 21:47:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Enhancement: handle gluetun port forwarded API change (#6011)

Browse Source
This commit is contained in:
shamoon
2025-11-25 13:28:50 -08:00
committed by GitHub
parent c36c6a9012
commit 5b50e8ff81
4 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/widgets/services/gluetun.md
View File

@@ -12,11 +12,17 @@ Learn more about [Gluetun](https://github.com/qdm12/gluetun).
Allowed fields: `["public_ip", "region", "country", "port_forwarded"]`.
Default fields: `["public_ip", "region", "country"]`.
To setup authentication, follow [the official Gluetun documentation](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md#authentication). 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.
To setup authentication, follow [the official Gluetun documentation](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md#authentication). 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` (or `/v1/portforward`) to your Gluetun config.toml.
| Gluetun Version | Homepage Widget Version |
| --------------- | ----------------------- |
| < 3.40.1 | 1 (default) |
| >= 3.40.1 | 2 |
```yaml
widget:
type: gluetun
url: http://gluetun.host.or.ip:port
key: gluetunkey # Not required if /v1/publicip/ip endpoint is configured with `auth = none`
version: 2 # optional, default is 1
```