mirror of
https://github.com/gethomepage/homepage.git
synced 2026-01-20 09:42:07 +08:00
Merge branch 'dev'
This commit is contained in:
@@ -189,6 +189,8 @@ labels: ...
|
||||
- homepage.widgets[1].slug=youreventslughere
|
||||
```
|
||||
|
||||
To pass custom HTTP headers with a widget request when using labels, use the same dot-notation: `homepage.widget.headers.X-Auth-Key=secret` (or `homepage.widgets[0].headers.X-Auth-Key=secret` when multiple widgets are present).
|
||||
|
||||
You can add specify fields for e.g. the [CustomAPI](../widgets/services/customapi.md) widget by using array-style dot notation:
|
||||
|
||||
```yaml
|
||||
|
||||
@@ -94,6 +94,7 @@ metadata:
|
||||
gethomepage.dev/name: Emby
|
||||
gethomepage.dev/widget.type: "emby"
|
||||
gethomepage.dev/widget.url: "https://emby.example.com"
|
||||
gethomepage.dev/widget.headers.X-Auth-Key: "your-secret-here"
|
||||
gethomepage.dev/pod-selector: ""
|
||||
gethomepage.dev/weight: 10 # optional
|
||||
gethomepage.dev/instance: "public" # optional
|
||||
|
||||
@@ -101,6 +101,25 @@ Each service can have multiple widgets attached to it, for example:
|
||||
|
||||
Multiple widgets per service are not yet supported with Kubernetes ingress annotations.
|
||||
|
||||
#### Custom HTTP headers
|
||||
|
||||
Widgets that make HTTP calls support extra request headers via `headers`. This is useful when a reverse proxy expects a secret header.
|
||||
|
||||
```yaml
|
||||
- UptimeRobot:
|
||||
icon: uptimekuma.png
|
||||
href: https://uptimerobot.com/
|
||||
widget:
|
||||
type: uptimerobot
|
||||
url: https://api.uptimerobot.com
|
||||
key: ${UPTIMEROBOT_API_KEY}
|
||||
headers:
|
||||
User-Agent: homepage
|
||||
X-Auth-Key: your-secret-here
|
||||
```
|
||||
|
||||
If you define services via Docker labels or Kubernetes annotations, use the same key with dot-notation (for example `homepage.widget.headers.X-Auth-Key=secret` or `gethomepage.dev/widget.headers.X-Auth-Key: "secret"`).
|
||||
|
||||
#### Field Visibility
|
||||
|
||||
Each widget can optionally provide a list of which fields should be visible via the `fields` widget property. If no fields are specified, then all fields will be displayed. The `fields` property must be a valid YAML array of strings. As an example, here is the entry for Sonarr showing only a couple of fields.
|
||||
|
||||
@@ -37,4 +37,4 @@ The value is a comma-separated (no spaces) list of allowed hosts (sometimes with
|
||||
|
||||
If you are seeing errors about host validation, check the homepage logs and ensure that the host exactly as output in the logs is in the `HOMEPAGE_ALLOWED_HOSTS` list.
|
||||
|
||||
This can be disabled by setting `HOMEPAGE_ALLOWED_HOSTS` to `*` but this is not recommended.
|
||||
This can be disabled by setting `HOMEPAGE_ALLOWED_HOSTS` to `*` but this is not recommended. Public deployments must rely on a reverse proxy (and/or VPN) that enforces authentication, TLS, and unexpected Host headers; the built-in host check is a best-effort guard for local setups and is not a substitute for edge protections.
|
||||
|
||||
16
docs/widgets/services/booklore.md
Normal file
16
docs/widgets/services/booklore.md
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: Booklore
|
||||
description: Booklore Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [Booklore](https://github.com/booklore-app/booklore).
|
||||
|
||||
The widget authenticates with your Booklore credentials to surface total libraries, books, and reading progress counts for your account.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: booklore
|
||||
url: https://booklore.host.or.ip
|
||||
username: username
|
||||
password: password
|
||||
```
|
||||
@@ -3,6 +3,8 @@ title: Gatus
|
||||
description: Gatus Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [Gatus](https://github.com/TwiN/gatus).
|
||||
|
||||
Allowed fields: `["up", "down", "uptime"]`.
|
||||
|
||||
```yaml
|
||||
|
||||
@@ -17,6 +17,7 @@ You can also find a list of all available service widgets in the sidebar navigat
|
||||
- [Azure DevOps](azuredevops.md)
|
||||
- [Backrest](backrest.md)
|
||||
- [Bazarr](bazarr.md)
|
||||
- [Booklore](booklore.md)
|
||||
- [Beszel](beszel.md)
|
||||
- [Caddy](caddy.md)
|
||||
- [Calendar](calendar.md)
|
||||
|
||||
@@ -9,11 +9,17 @@ _Note that the project was renamed from PiAlert to NetAlertX._
|
||||
|
||||
Allowed fields: `["total", "connected", "new_devices", "down_alerts"]`.
|
||||
|
||||
If you have enabled a password on your NetAlertX instance, you will need to provide the `SYNC_api_token` as the `key` in your config.
|
||||
Provide the `API_TOKEN` (f.k.a. `SYNC_api_token`) as the `key` in your config.
|
||||
|
||||
| NetAlertX Version | Homepage Widget Version |
|
||||
| ----------------- | ----------------------- |
|
||||
| < v26.1.17 | 1 (default) |
|
||||
| > v26.1.17 | 2 |
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: netalertx
|
||||
url: http://ip:port
|
||||
key: netalertxsyncapitoken # optional, only if password is enabled
|
||||
key: yournetalertxapitoken
|
||||
version: 2 # optional, default is 1
|
||||
```
|
||||
|
||||
@@ -5,6 +5,11 @@ description: TrueNas Scale Widget Configuration
|
||||
|
||||
Learn more about [TrueNas](https://www.truenas.com/).
|
||||
|
||||
| TrueNAS Version | Homepage widget version |
|
||||
| ----------------------- | ----------------------- |
|
||||
| < 26.04 (REST API) | 1 (default) |
|
||||
| > 25.04 (Websocket API) | 2 |
|
||||
|
||||
Allowed fields: `["load", "uptime", "alerts"]`.
|
||||
|
||||
To create an API Key, follow [the official TrueNAS documentation](https://www.truenas.com/docs/scale/scaletutorials/toptoolbar/managingapikeys/).
|
||||
@@ -17,6 +22,7 @@ To use the `enablePools` option with TrueNAS Core, the `nasType` parameter is re
|
||||
widget:
|
||||
type: truenas
|
||||
url: http://truenas.host.or.ip
|
||||
version: 2 # optional, defaults to 1
|
||||
username: user # not required if using api key
|
||||
password: pass # not required if using api key
|
||||
key: yourtruenasapikey # not required if using username / password
|
||||
|
||||
Reference in New Issue
Block a user