vh/homepage
1
0
Fork 0
mirror of https://github.com/gethomepage/homepage.git synced 2025-12-07 09:35:54 -08:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity
Files
6abb3d8758a326a6176f2085e3cc8209e0fbd501
homepage/docs/widgets/services/gluetun.md
Jasper d5f66e12fc
Some checks failed
Docker CI / Linting Checks (push) Has been cancelled
Details
Docker CI / Docker Build & Push (push) Has been cancelled
Details
Enhancement: Add port_forwarded field to Gluetun widget (#2262)
2025-05-12 08:16:13 -07:00

859 B
Raw 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"].

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.

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