mirror of
https://github.com/gethomepage/homepage.git
synced 2025-12-05 21:47:48 +01:00
29 lines
1.3 KiB
Markdown
29 lines
1.3 KiB
Markdown
---
|
|
title: Gluetun
|
|
description: Gluetun Widget Configuration
|
|
---
|
|
|
|
Learn more about [Gluetun](https://github.com/qdm12/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](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
|
|
```
|