Enhancement: extend hdhomerun widget (#2757)

Closes #2762

.github/FUNDING.yml

@@ -1,3 +1,3 @@
-github: benphelps
+github: [gethomepage, benphelps, shamoon]
 ko_fi: benphelps
 custom: ["https://paypal.me/phelpsben"]

.github/PULL_REQUEST_TEMPLATE.md

@@ -25,7 +25,7 @@ What type of change does your PR introduce to Homepage?
 
 ## Checklist:
 
-- [ ] If adding a service widget or a change that requires it, I have added corresponding documentation changes.
-- [ ] If adding a new widget I have reviewed the [guidelines](https://gethomepage.dev/latest/more/development/#service-widget-guidelines).
-- [ ] I have checked that all code style checks pass using pre-commit hooks and linting checks with `pnpm lint` (see development guidelines).
+- [ ] If applicable, I have added corresponding documentation changes.
+- [ ] If applicable, I have reviewed the [feature](https://gethomepage.dev/latest/more/development/#new-feature-guidelines) and / or [service widget guidelines](https://gethomepage.dev/latest/more/development/#service-widget-guidelines).
+- [ ] I have checked that all code style checks pass using [pre-commit hooks](https://gethomepage.dev/latest/more/development/#code-formatting-with-pre-commit-hooks) and [linting checks](https://gethomepage.dev/latest/more/development/#code-linting).
 - [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.

.github/workflows/crowdin.yml

@@ -0,0 +1,31 @@
+name: Crowdin Action
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '2 */12 * * *'
+  push:
+    paths: [
+      '/public/locales/en/**',
+    ]
+    branches: [ main ]
+
+jobs:
+  synchronize-with-crowdin:
+    name: Crowdin Sync
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: crowdin action
+      uses: crowdin/github-action@v1
+      with:
+        upload_translations: false
+        download_translations: true
+        crowdin_branch_name: main
+        localization_branch_name: l10n_main
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+        CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

.github/workflows/docker-publish.yml

@@ -41,7 +41,7 @@ jobs:
         uses: actions/checkout@v4
       -
         name: Install python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
       -

.github/workflows/docs-publish.yml

@@ -27,7 +27,7 @@ jobs:
         uses: actions/checkout@v4
       -
         name: Install python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
       -
@@ -42,11 +42,11 @@ jobs:
       - pre-commit
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.x
       - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
           path: .cache
@@ -67,18 +67,18 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ref: main
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v3
+      - run: echo "cache_id=${{github.sha}}" >> $GITHUB_ENV
+      - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
           path: .cache
           restore-keys: |
             mkdocs-material-
       - run: sudo apt-get install pngquant
-      - run: pip install mike==1.1.2
+      - run: pip install mike==2.0.0
       - run: pip install git+https://${GH_TOKEN}@github.com/benphelps/mkdocs-material-insiders.git
       - name: Set Git config
         run: |

crowdin.yml

@@ -1,3 +1,6 @@
+project_id_env: CROWDIN_PROJECT_ID
+api_token_env: CROWDIN_PERSONAL_TOKEN
+preserve_hierarchy: true
 files:
   - source: /public/locales/en/*.json
     translation: /public/locales/%osx_locale%/%original_file_name%

docs/configs/bookmarks.md

@@ -3,7 +3,7 @@ title: Bookmarks
 description: Bookmark Configuration
 ---
 
-Bookmarks function much the same as [Services](services.md), in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.
+Bookmarks are configured in the `bookmarks.yaml` file. They function much the same as [Services](services.md), in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.
 
 The design of homepage expects `abbr` to be 2 letters, but is not otherwise forced.
 
@@ -12,6 +12,7 @@ You can also use an icon for bookmarks similar to the [options for service icons
 By default, the description will use the hostname of the link, but you can override it with a custom description.
 
 ```yaml
+---
 - Developer:
     - Github:
         - abbr: GH
@@ -29,4 +30,8 @@ By default, the description will use the hostname of the link, but you can overr
           href: https://youtube.com/
 ```
 
+which renders to (depending on your theme, etc.):
+
 <img width="1000" alt="Bookmarks" src="https://user-images.githubusercontent.com/19408/269307009-d7e45885-230f-4e07-b421-9822017ae878.png">
+
+The default [bookmarks.yaml](https://github.com/gethomepage/homepage/blob/main/src/skeleton/bookmarks.yaml) is a working example.

docs/configs/docker.md

@@ -164,10 +164,10 @@ labels:
   - homepage.description=Media server
   - homepage.widget.type=customapi
   - homepage.widget.url=http://argus.service/api/v1/service/summary/emby
-  - homepage.widget.field[0].label=Deployed Version
-  - homepage.widget.field[0].field.status=deployed_version
-  - homepage.widget.field[1].label=Latest Version
-  - homepage.widget.field[1].field.status=latest_version
+  - homepage.widget.mappings[0].label=Deployed Version
+  - homepage.widget.mappings[0].field.status=deployed_version
+  - homepage.widget.mappings[1].label=Latest Version
+  - homepage.widget.mappings[1].field.status=latest_version
 ```
 
 ## Docker Swarm

docs/configs/kubernetes.md

@@ -79,6 +79,7 @@ metadata:
     gethomepage.dev/widget.url: "https://emby.example.com"
     gethomepage.dev/pod-selector: ""
     gethomepage.dev/weight: 10 # optional
+    gethomepage.dev/instance: "public" # optional
 spec:
   rules:
     - host: emby.example.com
@@ -95,6 +96,8 @@ spec:
 
 When the Kubernetes cluster connection has been properly configured, this service will be automatically discovered and added to your Homepage. **You do not need to specify the `namespace` or `app` values, as they will be automatically inferred.**
 
+If you are using multiple instances of homepage, an `instance` annotation can be specified to limit services to a specific instance. If no instance is provided, the service will be visible on all instances.
+
 ### Traefik IngressRoute support
 
 Homepage can also read ingresses defined using the Traefik IngressRoute custom resource definition. Due to the complex nature of Traefik routing rules, it is required for the `gethomepage.dev/href` annotation to be set:
@@ -116,6 +119,7 @@ metadata:
     gethomepage.dev/widget.url: "https://emby.example.com"
     gethomepage.dev/pod-selector: ""
     gethomepage.dev/weight: 10 # optional
+    gethomepage.dev/instance: "public" # optional
 spec:
   entryPoints:
     - websecure

docs/configs/services.md

@@ -179,7 +179,7 @@ Services may be connected to a Docker container, either running on the local mac
 
 Services may also have a service widget (or integration) attached to them, this works independently of the Docker integration.
 
-You can find information and configuration for each of the supported integrations on the [Service Widgets](service-widgets.md) page.
+You can find information and configuration for each of the supported integrations on the [Widgets](../widgets/index.md) page.
 
 Here is an example of a Radarr & Sonarr service, with their respective integrations.
 

docs/configs/settings.md

@@ -229,6 +229,28 @@ disableCollapse: true
 
 By default the feature is enabled.
 
+### Use Equal Height Cards
+
+You can enable equal height cards for groups of services, this will make all cards in a row the same height.
+
+Global setting in `settings.yaml`:
+
+```yaml
+useEqualHeights: true
+```
+
+Per layout group in `settings.yaml`:
+
+```yaml
+useEqualHeights: false
+layout:
+  ...
+  Group Name:
+    useEqualHeights: true # overrides global setting
+```
+
+By default the feature is disabled
+
 ## Header Style
 
 There are currently 4 options for header styles, you can see each one below.

docs/more/development.md

@@ -39,11 +39,17 @@ Once installed, hooks will run when you commit. If the formatting isn't quite ri
 
 See the [pre-commit documentation](https://pre-commit.com/#install) to get started.
 
+## New Feature Guidelines
+
+- New features should be linked to an existing feature request with at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users.
+- If you have ideas for a larger feature, please open a discussion first.
+- Please note that though it is a requirement, a discussion with 10 'up-votes' in no way guarantees that a PR will be merged.
+
 ## Service Widget Guidelines
 
 To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:
 
-- Please only submit widgets that have been requested and have at least 5 'up-votes'
+- Please only submit widgets that have been requested and have at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
 - Widgets should be only one row of blocks
 - Widgets should be no more than 4 blocks wide
 - Minimize the number of API calls

docs/widgets/index.md

@@ -7,7 +7,7 @@ Homepage has two types of widgets: info and service. Below we'll cover each type
 
 ## Service Widgets
 
-Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your `services.yml` file. Here's an example:
+Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your `services.yaml` file. Here's an example:
 
 ```yaml
 - Plex:
@@ -24,7 +24,7 @@ Service widgets are used to display the status of a service, often a web service
 
 ## Info Widgets
 
-Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yml` file. Here's an example:
+Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yaml` file. Here's an example:
 
 ```yaml
 - openmeteo:

docs/widgets/services/adguard-home.md

@@ -3,6 +3,8 @@ title: Adguard Home
 description: Adguard Home Widget Configuration
 ---
 
+Learn more about [Adguard Home](https://github.com/AdguardTeam/AdGuardHome).
+
 The username and password are the same as used to login to the web interface.
 
 Allowed fields: `["queries", "blocked", "filtered", "latency"]`.

docs/widgets/services/atsumeru.md

@@ -3,6 +3,8 @@ title: Atsumeru
 description: Atsumeru Widget Configuration
 ---
 
+Learn more about [Atsumeru](https://github.com/AtsumeruDev/Atsumeru).
+
 Define same username and password that is used for login from web or supported apps
 
 Allowed fields: `["series", "archives", "chapters", "categories"]`.

docs/widgets/services/audiobookshelf.md

@@ -3,6 +3,8 @@ title: Audiobookshelf
 description: Audiobookshelf Widget Configuration
 ---
 
+Learn more about [Audiobookshelf](https://github.com/advplyr/audiobookshelf).
+
 You can find your API token by logging into the Audiobookshelf web app as an admin, go to the config → users page, and click on your account.
 
 Allowed fields: `["podcasts", "podcastsDuration", "books", "booksDuration"]`

docs/widgets/services/authentik.md

@@ -3,6 +3,8 @@ title: Authentik
 description: Authentik Widget Configuration
 ---
 
+Learn more about [Authentik](https://github.com/goauthentik/authentik).
+
 This widget reads the number of active users in the system, as well as logins for the last 24 hours.
 
 You will need to generate an API token for an existing user. To do so follow these steps:

docs/widgets/services/autobrr.md

@@ -3,6 +3,8 @@ title: Autobrr
 description: Autobrr Widget Configuration
 ---
 
+Learn more about [Autobrr](https://github.com/autobrr/autobrr).
+
 Find your API key under `Settings > API Keys`.
 
 Allowed fields: `["approvedPushes", "rejectedPushes", "filters", "indexers"]`.

docs/widgets/services/azuredevops.md

@@ -3,6 +3,8 @@ title: Azure DevOps
 description: Azure DevOps Widget Configuration
 ---
 
+Learn more about [Azure DevOps](https://azure.microsoft.com/en-us/products/devops).
+
 This widget has 2 functions:
 
 1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.\

docs/widgets/services/bazarr.md

@@ -3,6 +3,8 @@ title: Bazarr
 description: Bazarr Widget Configuration
 ---
 
+Learn more about [Bazarr](https://github.com/morpheus65535/bazarr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["missingEpisodes", "missingMovies"]`.

docs/widgets/services/caddy.md

@@ -3,6 +3,8 @@ title: Caddy
 description: Caddy Widget Configuration
 ---
 
+Learn more about [Caddy](https://github.com/caddyserver/caddy).
+
 Allowed fields: `["upstreams", "requests", "requests_failed"]`.
 
 ```yaml

docs/widgets/services/calendar.md

@@ -16,6 +16,7 @@ widget:
   view: monthly # optional - possible values monthly, agenda
   maxEvents: 10 # optional - defaults to 10
   showTime: true # optional - show time for event happening today - defaults to false
+  timezone: America/Los_Angeles # optional and only when timezone is not detected properly (slightly slower performance) - force timezone for ical events (if it's the same - no change, if missing or different in ical - will be converted to this timezone)
   integrations: # optional
     - type: sonarr # active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr, ical
       service_group: Media # group name where widget exists

docs/widgets/services/calibre-web.md

@@ -3,7 +3,9 @@ title: Calibre-web
 description: Calibre-web Widget Configuration
 ---
 
-**Note: this widget requires a feature of calibre-web that has not yet been distributed in versioned release. The code is contained in ["nightly" lsio builds after 25/8/23](https://hub.docker.com/layers/linuxserver/calibre-web/nightly/images/sha256-b27cbe5d17503de38135d925e226eb3e5ba04c558dbc865dc85d77824d35d7e2) or running the calibre-web source code including commit [0499e57](https://github.com/janeczku/calibre-web/commit/0499e578cdd45db656da34cd2d7152c8d88ceb23).**
+Learn more about [Calibre-web](https://github.com/janeczku/calibre-web).
+
+**Note: widget requires calibre-web ≥ v0.6.21.**
 
 Allowed fields: `["books", "authors", "categories", "series"]`.
 

docs/widgets/services/changedetectionio.md

@@ -3,6 +3,8 @@ title: Changedetection.io
 description: Changedetection.io Widget Configuration
 ---
 
+Learn more about [Changedetection.io](https://github.com/dgtlmoon/changedetection.io).
+
 Find your API key under `Settings > API`.
 
 ```yaml

docs/widgets/services/channelsdvrserver.md

@@ -3,6 +3,8 @@ title: Channels DVR Server
 description: Channels DVR Server Widget Configuration
 ---
 
+Learn more about [Channels DVR Server](https://getchannels.com/dvr-server/).
+
 ```yaml
 widget:
   type: channelsdvrserver

docs/widgets/services/cloudflared.md

@@ -3,6 +3,8 @@ title: Cloudflare Tunnels
 description: Cloudflare Tunnels Widget Configuration
 ---
 
+Learn more about [Cloudflare Tunnels](https://www.cloudflare.com/products/tunnel/).
+
 _As of v0.6.10 this widget no longer accepts a Cloudflare global API key (or account email) due to security concerns. Instead, you should setup an API token which only requires the permissions `Account.Cloudflare Tunnel:Read`._
 
 Allowed fields: `["status", "origin_ip"]`.

docs/widgets/services/coin-market-cap.md

@@ -3,6 +3,8 @@ title: Coin Market Cap
 description: Coin Market Cap Widget Configuration
 ---
 
+Learn more about [Coin Market Cap](https://coinmarketcap.com/api).
+
 Get your API key from your [CoinMarketCap Pro Dashboard](https://pro.coinmarketcap.com/account).
 
 Allowed fields: no configurable fields for this widget.
@@ -16,7 +18,7 @@ widget:
   defaultinterval: 7d # Optional
 ```
 
-You can also specify slugs instead of symbols (since symbols aren't garaunteed to be unique). If you supply both, slugs will be used. For example:
+You can also specify slugs instead of symbols (since symbols aren't guaranteed to be unique). If you supply both, slugs will be used. For example:
 
 ```yaml
 widget:

docs/widgets/services/customapi.md

@@ -34,11 +34,20 @@ widget:
     - field: key # needs to be YAML string or object
       label: Field 4
       format: date # optional - defaults to text
+      locale: nl # optional
       dateStyle: long # optional - defaults to "long". Allowed values: `["full", "long", "medium", "short"]`.
       timeStyle: medium # optional - Allowed values: `["full", "long", "medium", "short"]`.
+    - field: key # needs to be YAML string or object
+      label: Field 5
+      format: relativeDate # optional - defaults to text
+      locale: nl # optional
+      style: short # optional - defaults to "long". Allowed values: `["long", "short", "narrow"]`.
+      numeric: auto # optional - defaults to "always". Allowed values `["always", "auto"]`.
 ```
 
-Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate` and `date`.
+Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `date` and `relativeDate`.
+
+The `dateStyle` and `timeStyle` options of the `date` format are passed directly to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat) and the `style` and `numeric` options of `relativeDate` are passed to [Intl.RelativeTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat).
 
 ## Example
 

docs/widgets/services/deluge.md

@@ -3,6 +3,8 @@ title: Deluge
 description: Deluge Widget Configuration
 ---
 
+Learn more about [Deluge](https://deluge-torrent.org/).
+
 Uses the same password used to login to the webui, see [the deluge FAQ](https://dev.deluge-torrent.org/wiki/Faq#Whatisthedefaultpassword).
 
 Allowed fields: `["leech", "download", "seed", "upload"]`.

docs/widgets/services/diskstation.md

@@ -3,6 +3,8 @@ title: Synology Disk Station
 description: Synology Disk Station Widget Configuration
 ---
 
+Learn more about [Synology Disk Station](https://www.synology.com/en-global/dsm).
+
 Note: the widget is not compatible with 2FA.
 
 An optional 'volume' parameter can be supplied to specify which volume's free space to display when more than one volume exists. The value of the parameter must be in form of `volume_N`, e.g. to display free space for volume2, `volume_2` should be set as 'volume' value. If omitted, first returned volume's free space will be shown (not guaranteed to be volume1).

docs/widgets/services/downloadstation.md

@@ -3,6 +3,8 @@ title: Synology Download Station
 description: Synology Download Station Widget Configuration
 ---
 
+Learn more about [Synology Download Station](https://www.synology.com/en-us/dsm/packages/DownloadStation).
+
 Note: the widget is not compatible with 2FA.
 
 Allowed fields: `["leech", "download", "seed", "upload"]`.

docs/widgets/services/emby.md

@@ -3,6 +3,8 @@ title: Emby
 description: Emby Widget Configuration
 ---
 
+Learn more about [Emby](https://github.com/MediaBrowser/Emby).
+
 You can create an API key from inside Emby at `Settings > Advanced > Api Keys`.
 
 As of v0.6.11 the widget supports fields `["movies", "series", "episodes", "songs"]`. These blocks are disabled by default but can be enabled with the `enableBlocks` option, and the "Now Playing" feature (enabled by default) can be disabled with the `enableNowPlaying` option.

docs/widgets/services/evcc.md

@@ -3,6 +3,8 @@ title: EVCC
 description: EVCC Widget Configuration
 ---
 
+Learn more about [EVSS](https://github.com/evcc-io/evcc).
+
 Allowed fields: `["pv_power", "grid_power", "home_power", "charge_power]`.
 
 ```yaml

docs/widgets/services/fileflows.md

@@ -3,6 +3,8 @@ title: Fileflows
 description: Fileflows Widget Configuration
 ---
 
+Learn more about [FileFlows](https://github.com/revenz/FileFlows).
+
 Allowed fields: `["queue", "processing", "processed", "time"]`.
 
 ```yaml

docs/widgets/services/flood.md

@@ -3,6 +3,8 @@ title: Flood
 description: Flood Widget Configuration
 ---
 
+Learn more about [Flood](https://github.com/jesec/flood).
+
 Allowed fields: `["leech", "download", "seed", "upload"]`.
 
 ```yaml

docs/widgets/services/freshrss.md

@@ -3,6 +3,8 @@ title: FreshRSS
 description: FreshRSS Widget Configuration
 ---
 
+Learn more about [FreshRSS](https://github.com/FreshRSS/FreshRSS).
+
 Please refer to [Enable the API in FreshRSS](https://freshrss.github.io/FreshRSS/en/users/06_Mobile_access.html#enable-the-api-in-freshrss) for the "API password" to be entered in the password field.
 
 Allowed fields: `["subscriptions", "unread"]`.

docs/widgets/services/fritzbox.md

@@ -0,0 +1,22 @@
+---
+title: FRITZ!Box
+description: FRITZ!Box Widget Configuration
+---
+
+Application access & UPnP must be activated on your device:
+
+```
+Home Network > Network > Network Settings > Access Settings in the Home Network
+[x] Allow access for applications
+[x] Transmit status information over UPnP
+```
+
+Credentials are not needed and, as such, you may want to consider using `http` instead of `https` as those requests are significantly faster.
+
+Allowed fields (limited to a max of 4): `["connectionStatus", "uptime", "maxDown", "maxUp", "down", "up", "received", "sent", "externalIPAddress"]`.
+
+```yaml
+widget:
+  type: fritzbox
+  url: http://192.168.178.1
+```

docs/widgets/services/gamedig.md

@@ -3,6 +3,8 @@ title: GameDig
 description: GameDig Widget Configuration
 ---
 
+Learn more about [GameDig](https://github.com/gamedig/node-gamedig).
+
 Uses the [GameDig](https://www.npmjs.com/package/gamedig) library to get game server information for any supported server type.
 
 Allowed fields (limited to a max of 4): `["status", "name", "map", "currentPlayers", "players", "maxPlayers", "bots", "ping"]`.

docs/widgets/services/gatus.md

@@ -0,0 +1,12 @@
+---
+title: Gatus
+description: Gatus Widget Configuration
+---
+
+Allowed fields: `["up", "down", "uptime"]`.
+
+```yaml
+widget:
+  type: gatus
+  url: http://gatus.host.or.ip:port
+```

docs/widgets/services/ghostfolio.md

@@ -3,6 +3,8 @@ title: Ghostfolio
 description: Ghostfolio Widget Configuration
 ---
 
+Learn more about [Ghostfolio](https://github.com/ghostfolio/ghostfolio).
+
 Authentication requires manually obtaining a Bearer token which can be obtained by make a POST request to the API e.g.
 
 ```

docs/widgets/services/glances.md

@@ -3,6 +3,8 @@ title: Glances
 description: Glances Widget Configuration
 ---
 
+Learn more about [Glances](https://github.com/nicolargo/glances).
+
 <img width="1614" alt="glances" src="https://github-production-user-asset-6210df.s3.amazonaws.com/82196/257382012-25648c97-2c1b-4db0-b5a5-f1509806079c.png">
 
 _(Find the Glances information widget [here](../info/glances.md))_

docs/widgets/services/gluetun.md

@@ -3,6 +3,8 @@ title: Gluetun
 description: Gluetun Widget Configuration
 ---
 
+Learn more about [Glueton](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`.

docs/widgets/services/gotify.md

@@ -3,6 +3,8 @@ title: Gotify
 description: Gotify Widget Configuration
 ---
 
+Learn more about [Gotify](https://github.com/gotify/server).
+
 Get a Gotify client token from an existing client or create a new one on your Gotify admin page.
 
 Allowed fields: `["apps", "clients", "messages"]`.

docs/widgets/services/grafana.md

@@ -3,6 +3,8 @@ title: Grafana
 description: Grafana Widget Configuration
 ---
 
+Learn more about [Grafana](https://github.com/grafana/grafana).
+
 Allowed fields: `["dashboards", "datasources", "totalalerts", "alertstriggered"]`.
 
 ```yaml

docs/widgets/services/hdhomerun.md

@@ -3,10 +3,16 @@ title: HDHomerun
 description: HDHomerun Widget Configuration
 ---
 
-Allowed fields: `["channels", "hd"]`.
+Learn more about [HDHomerun](https://www.silicondust.com/support/downloads/).
+
+Allowed fields: `["channels", "hd", "tunerCount", "channelNumber", "channelNetwork", "signalStrength", "signalQuality", "symbolQuality", "networkRate", "clientIP" ]`.
+
+If more than 4 fields are provided, only the first 4 are displayed.
 
 ```yaml
 widget:
   type: hdhomerun
   url: http://hdhomerun.host.or.ip
+  tuner: 0 # optional - defaults to 0, used for tuner-specific fields
+  fields: ["channels", "hd"] # optional - default fields shown
 ```

docs/widgets/services/healthchecks.md

@@ -3,18 +3,23 @@ title: Health checks
 description: Health checks Widget Configuration
 ---
 
-To use the Health Checks widget, you first need to generate an API key. To do this, follow these steps:
+Learn more about [Health Checks](https://github.com/healthchecks/healthchecks).
 
-1. Go to Settings in your check dashboard.
+Specify a single check by including the `uuid` field or show the total 'up' and 'down' for all
+checks by leaving off the `uuid` field.
+
+To use the Health Checks widget, you first need to generate an API key.
+
+1. In your project, go to project Settings on the navigation bar.
 2. Click on API key (read-only) and then click _Create_.
 3. Copy the API key that is generated for you.
 
-Allowed fields: `["status", "last_ping"]`.
+Allowed fields: `["status", "last_ping"]` for single checks, `["up", "down"]` for total stats.
 
 ```yaml
 widget:
   type: healthchecks
   url: http://healthchecks.host.or.ip:port
   key: <YOUR_API_KEY>
-  uuid: <YOUR_CHECK_UUID>
+  uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown
 ```

docs/widgets/services/homeassistant.md

@@ -3,6 +3,8 @@ title: Home Assistant
 description: Home Assistant Widget Configuration
 ---
 
+Learn more about [Home Assistant](https://www.home-assistant.io/).
+
 You will need to generate a long-lived access token for an existing Home Assistant user in its profile.
 
 Allowed fields: `["people_home", "lights_on", "switches_on"]`.

docs/widgets/services/homebridge.md

@@ -3,6 +3,8 @@ title: Homebridge
 description: Homebridge
 ---
 
+Learn more about [Homebridge](https://github.com/homebridge/homebridge).
+
 The Homebridge API is actually provided by the Config UI X plugin that has been included with Homebridge for a while, still it is required to be installed for this widget to work.
 
 Allowed fields: `["updates", "child_bridges"]`.

docs/widgets/services/iframe.md

@@ -27,7 +27,7 @@ widget:
   src: http://example.com
   classes: h-60 sm:h-60 md:h-60 lg:h-60 xl:h-60 2xl:h-72 # optional, use tailwind height classes, see https://tailwindcss.com/docs/height
   referrerPolicy: same-origin # optional, no default
-  allowPolicy: autoplay fullscreen gamepad # optional, no default
+  allowPolicy: autoplay; fullscreen; gamepad # optional, no default
   allowFullscreen: false # optional, default: true
   loadingStrategy: eager # optional, default: eager
   allowScrolling: no # optional, default: yes

docs/widgets/services/immich.md

@@ -3,6 +3,10 @@ title: Immich
 description: Immich Widget Configuration
 ---
 
+Learn more about [Immich](https://github.com/immich-app/immich).
+
+Find your API key under `Account Settings > API Keys`.
+
 Allowed fields: `["users" ,"photos", "videos", "storage"]`.
 
 Note that API key must be from admin user.

docs/widgets/services/jackett.md

@@ -3,6 +3,8 @@ title: Jackett
 description: Jackett Widget Configuration
 ---
 
+Learn more about [Jackett](https://github.com/Jackett/Jackett).
+
 Jackett must not have any authentication for the widget to work.
 
 Allowed fields: `["configured", "errored"]`.

docs/widgets/services/jdownloader.md

@@ -3,6 +3,8 @@ title: JDownloader
 description: NextPVR Widget Configuration
 ---
 
+Learn more about [JDownloader](https://jdownloader.org/).
+
 Basic widget to show number of items in download queue, along with the queue size and current download speed.
 
 Allowed fields: `["downloadCount", "downloadTotalBytes","downloadBytesRemaining", "downloadSpeed"]`.

docs/widgets/services/jellyfin.md

@@ -3,6 +3,8 @@ title: Jellyfin
 description: Jellyfin Widget Configuration
 ---
 
+Learn more about [Jellyfin](https://github.com/jellyfin/jellyfin).
+
 You can create an API key from inside Jellyfin at `Settings > Advanced > Api Keys`.
 
 As of v0.6.11 the widget supports fields `["movies", "series", "episodes", "songs"]`. These blocks are disabled by default but can be enabled with the `enableBlocks` option, and the "Now Playing" feature (enabled by default) can be disabled with the `enableNowPlaying` option.

docs/widgets/services/jellyseerr.md

@@ -3,6 +3,8 @@ title: Jellyseerr
 description: Jellyseerr Widget Configuration
 ---
 
+Learn more about [Jellyseerr](https://github.com/Fallenbagel/jellyseerr).
+
 Find your API key under `Settings > General > API Key`.
 
 Allowed fields: `["pending", "approved", "available"]`.

docs/widgets/services/kavita.md

@@ -3,6 +3,8 @@ title: Kavita
 description: Kavita Widget Configuration
 ---
 
+Learn more about [Kavita](https://github.com/Kareadita/Kavita).
+
 Uses the same username and password used to login from the web.
 
 Allowed fields: `["seriesCount", "totalFiles"]`.

docs/widgets/services/komga.md

@@ -3,6 +3,8 @@ title: Komga
 description: Komga Widget Configuration
 ---
 
+Learn more about [Komga](https://github.com/gotson/komga).
+
 Uses the same username and password used to login from the web.
 
 Allowed fields: `["libraries", "series", "books"]`.

docs/widgets/services/kopia.md

@@ -3,6 +3,8 @@ title: Kopia
 description: Kopia Widget Configuration
 ---
 
+Learn more about [Kopia](https://github.com/kopia/kopia).
+
 Allowed fields: `["status", "size", "lastrun", "nextrun"]`.
 
 You may optionally pass values for `snapshotHost` and / or `snapshotPath` to select a specific backup source for the widget.

docs/widgets/services/lidarr.md

@@ -3,6 +3,8 @@ title: Lidarr
 description: Lidarr Widget Configuration
 ---
 
+Learn more about [Lidarr](https://github.com/Lidarr/Lidarr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["wanted", "queued", "artists"]`.

docs/widgets/services/mastodon.md

@@ -3,6 +3,8 @@ title: Mastodon
 description: Mastodon Widget Configuration
 ---
 
+Learn more about [Mastodon](https://github.com/mastodon/mastodon).
+
 Use the base URL of the Mastodon instance you'd like to pull stats for. Does not require authentication as the stats are part of the public API endpoints.
 
 Allowed fields: `["user_count", "status_count", "domain_count"]`.

docs/widgets/services/mealie.md

@@ -3,6 +3,8 @@ title: Mealie
 description: Mealie Widget Configuration
 ---
 
+Learn more about [Mealie](https://github.com/mealie-recipes/mealie).
+
 Generate a user API key under `Profile > Manage Your API Tokens > Generate`.
 
 Allowed fields: `["recipes", "users", "categories", "tags"]`.

docs/widgets/services/medusa.md

@@ -3,6 +3,8 @@ title: Medusa
 description: Medusa Widget Configuration
 ---
 
+Learn more about [Medusa](https://github.com/medusajs/medusa).
+
 Allowed fields: `["wanted", "queued", "series"]`.
 
 ```yaml

docs/widgets/services/miniflux.md

@@ -3,6 +3,8 @@ title: Miniflux
 description: Miniflux Widget Configuration
 ---
 
+Learn more about [Miniflux](https://github.com/miniflux/v2).
+
 Api key is found under Settings > API keys
 
 Allowed fields: `["unread", "read"]`.

docs/widgets/services/moonraker.md

@@ -3,6 +3,8 @@ title: Moonraker (Klipper)
 description: Moonraker (Klipper) Widget Configuration
 ---
 
+Learn more about [Moonraker](https://github.com/Arksine/moonraker).
+
 Allowed fields: `["printer_state", "print_status", "print_progress", "layers"]`.
 
 ```yaml

docs/widgets/services/mylar.md

@@ -3,6 +3,8 @@ title: Mylar3
 description: Mylar3 Widget Configuration
 ---
 
+Learn more about [Mylar3](https://github.com/mylar3/mylar3).
+
 API must be enabled in Mylar3 settings.
 
 Allowed fields: `["series", "issues", "wanted"]`.

docs/widgets/services/navidrome.md

@@ -3,6 +3,8 @@ title: Navidrome
 description: Navidrome Widget Configuration
 ---
 
+Learn more about [Navidrome](https://github.com/navidrome/navidrome).
+
 For detailed information about how to generate the token see http://www.subsonic.org/pages/api.jsp.
 
 Allowed fields: no configurable fields for this widget.

docs/widgets/services/netdata.md

@@ -0,0 +1,14 @@
+---
+title: Netdata
+description: Netdata Widget Configuration
+---
+
+Learn more about [Netdata](https://github.com/netdata/netdata).
+
+Allowed fields: `["warnings", "criticals"]`.
+
+```yaml
+widget:
+  type: netdata
+  url: http://netdata.host.or.ip
+```

docs/widgets/services/nextcloud.md

@@ -3,6 +3,8 @@ title: Nextcloud
 description: Nextcloud Widget Configuration
 ---
 
+Learn more about [Nextcloud](https://github.com/nextcloud).
+
 Use username & password, or the `NC-Token` key. Information about the token can be found under **Settings** > **System**. If both are provided, NC-Token will be used.
 
 Allowed fields: `["cpuload", "memoryusage", "freespace", "activeusers", "numfiles", "numshares"]`.

docs/widgets/services/nextdns.md

@@ -3,6 +3,8 @@ title: NextDNS
 description: NextDNS Widget Configuration
 ---
 
+Learn more about [NextDNS](https://nextdns.io/).
+
 Api key is found under Account > API, profile ID is found under Setup > Endpoints > ID
 
 ```yaml

docs/widgets/services/nginx-proxy-manager.md

@@ -3,6 +3,8 @@ title: Nginx Proxy Manager
 description: Nginx Proxy Manager Widget Configuration
 ---
 
+Learn more about [Nginx Proxy Manager](https://nginxproxymanager.com/).
+
 Login with the same admin username and password used to access the web UI.
 
 Allowed fields: `["enabled", "disabled", "total"]`.

docs/widgets/services/nzbget.md

@@ -3,6 +3,8 @@ title: NZBget
 description: NZBget Widget Configuration
 ---
 
+Learn more about [NZBget](https://github.com/nzbget/nzbget).
+
 This widget uses the same authentication method as your browser when logging in (HTTP Basic Auth), and is often referred to as the ControlUsername and ControlPassword inside of Nzbget documentation.
 
 Allowed fields: `["rate", "remaining", "downloaded"]`.

docs/widgets/services/octoprint.md

@@ -3,6 +3,8 @@ title: OctoPrint
 description: OctoPrintWidget Configuration
 ---
 
+Learn more about [OctoPrint](https://octoprint.org/).
+
 Allowed fields: `["printer_state", "temp_tool", "temp_bed", "job_completion"]`.
 
 ```yaml

docs/widgets/services/ombi.md

@@ -3,6 +3,8 @@ title: Ombi
 description: Ombi Widget Configuration
 ---
 
+Learn more about [Ombi](https://github.com/Ombi-app/Ombi).
+
 Find your API key under `Settings > Configuration > General`.
 
 Allowed fields: `["pending", "approved", "available"]`.

docs/widgets/services/opendtu.md

@@ -3,6 +3,8 @@ title: OpenDTU
 description: OpenDTU Widget
 ---
 
+Learn more about [OpenDTU](https://github.com/tbnobody/OpenDTU).
+
 Allowed fields: `["yieldDay", "relativePower", "absolutePower", "limit"]`.
 
 ```yaml

docs/widgets/services/openmediavault.md

@@ -3,6 +3,8 @@ title: OpenMediaVault
 description: OpenMediaVault Widget Configuration
 ---
 
+Learn more about [OpenMediaVault](https://www.openmediavault.org/).
+
 Provides useful information from your OpenMediaVault
 
 ```yaml

docs/widgets/services/opnsense.md

@@ -3,6 +3,8 @@ title: OPNSense
 description: OPNSense Widget Configuration
 ---
 
+Learn more about [OPNSense](https://opnsense.org/).
+
 The API key & secret can be generated via the webui by creating a new user at _System/Access/Users_. Ensure "Generate a scrambled password to prevent local database logins for this user" is checked and then edit the effective privileges selecting **only**:
 
 - Diagnostics: System Activity

docs/widgets/services/overseerr.md

@@ -3,6 +3,8 @@ title: Overseerr
 description: Overseerr Widget Configuration
 ---
 
+Learn more about [Overseerr](https://github.com/sct/overseerr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["pending", "approved", "available", "processing"]`.

docs/widgets/services/paperlessngx.md

@@ -3,6 +3,8 @@ title: Paperless-ngx
 description: Paperless-ngx Widget Configuration
 ---
 
+Learn more about [Paperless-ngx](https://github.com/paperless-ngx/paperless-ngx).
+
 Use username & password, or the token key. Information about the token can be found in the [Paperless-ngx API documentation](https://docs.paperless-ngx.com/api/#authorization). If both are provided, the token will be used.
 
 Allowed fields: `["total", "inbox"]`.

docs/widgets/services/peanut.md

@@ -0,0 +1,23 @@
+---
+title: PeaNUT
+description: PeaNUT Widget Configuration
+---
+
+Learn more about [PeaNUT](https://github.com/Brandawg93/PeaNUT).
+
+This widget adds support for [Network UPS Tools](https://networkupstools.org/) via a third party tool, [PeaNUT](https://github.com/Brandawg93/PeaNUT).
+
+The default ups name is `ups`. To configure more than one ups, you must create multiple peanut services.
+
+Allowed fields: `["battery_charge", "ups_load", "ups_status"]`
+
+!!! note
+
+    This widget requires an additional tool, [PeaNUT](https://github.com/Brandawg93/PeaNUT), as noted. Other projects exist to achieve similar results using a `customapi` widget, for example [NUTCase](https://github.com/ArthurMitchell42/nutcase#using-nutcase-homepage).
+
+```yaml
+widget:
+  type: peanut
+  url: http://peanut.host.or.ip:port
+  key: nameofyourups
+```

docs/widgets/services/pfsense.md

@@ -3,6 +3,8 @@ title: pfSense
 description: pfSense Widget Configuration
 ---
 
+Learn more about [pfSense](https://github.com/pfsense/pfsense).
+
 This widget requires the installation of the [pfsense-api](https://github.com/jaredhendrickson13/pfsense-api) which is a 3rd party package for pfSense routers.
 
 Once pfSense API is installed, you can set the API to be read-only in System > API > Settings.

docs/widgets/services/photoprism.md

@@ -3,6 +3,8 @@ title: PhotoPrism
 description: PhotoPrism Widget Configuration
 ---
 
+Learn more about [PhotoPrism](https://github.com/photoprism/photoprism)..
+
 Allowed fields: `["albums", "photos", "videos", "people"]`.
 
 ```yaml

docs/widgets/services/pialert.md

@@ -3,6 +3,8 @@ title: PiAlert
 description: PiAlert Widget Configuration
 ---
 
+Learn more about [PiAlert](https://github.com/pucherot/Pi.Alert).
+
 Widget for [PiAlert](https://github.com/jokob-sk/Pi.Alert).
 
 Allowed fields: `["total", "connected", "new_devices", "down_alerts"]`.

docs/widgets/services/pihole.md

@@ -3,6 +3,8 @@ title: PiHole
 description: PiHole Widget Configuration
 ---
 
+Learn more about [PiHole](https://github.com/pi-hole/pi-hole).
+
 As of v2022.12 [PiHole requires the use of an API key](https://pi-hole.net/blog/2022/11/17/upcoming-changes-authentication-for-more-api-endpoints-required/#page-content) if an admin password is set. Older versions do not require any authentication even if the admin uses a password.
 
 Allowed fields: `["queries", "blocked", "blocked_percent", "gravity"]`.

docs/widgets/services/plex-tautulli.md

@@ -3,6 +3,8 @@ title: Tautulli (Plex)
 description: Tautulli Widget Configuration
 ---
 
+Learn more about [Tautulli](https://github.com/Tautulli/Tautulli).
+
 Provides detailed information about currently active streams. You can find the API key from inside Tautulli at `Settings > Web Interface > API`.
 
 Allowed fields: no configurable fields for this widget.

docs/widgets/services/plex.md

@@ -3,6 +3,8 @@ title: Plex
 description: Plex Widget Configuration
 ---
 
+Learn more about [Plex](https://www.plex.tv/).
+
 The core Plex API is somewhat limited but basic info regarding library sizes and the number of active streams is supported. For more detailed info regarding active streams see the [Plex Tautulli widget](plex-tautulli.md).
 
 Allowed fields: `["streams", "albums", "movies", "tv"]`.

docs/widgets/services/portainer.md

@@ -3,6 +3,8 @@ title: Portainer
 description: Portainer Widget Configuration
 ---
 
+Learn more about [Portainer](https://github.com/portainer/portainer).
+
 You'll need to make sure you have the correct environment set for the integration to work properly. From the Environments section inside of Portainer, click the one you'd like to connect to and observe the ID at the end of the URL (should be), something like `#!/endpoints/1`, here `1` is the value to set as the `env` value. In order to generate an API key, please follow the steps outlined here https://docs.portainer.io/api/access.
 
 Allowed fields: `["running", "stopped", "total"]`.

docs/widgets/services/prometheus.md

@@ -3,6 +3,8 @@ title: Prometheus
 description: Prometheus Widget Configuration
 ---
 
+Learn more about [Prometheus](https://github.com/prometheus/prometheus).
+
 Allowed fields: `["targets_up", "targets_down", "targets_total"]`
 
 ```yaml

docs/widgets/services/prowlarr.md

@@ -3,6 +3,8 @@ title: Prowlarr
 description: Prowlarr Widget Configuration
 ---
 
+Learn more about [Prowlarr](https://github.com/Prowlarr/Prowlarr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["numberOfGrabs", "numberOfQueries", "numberOfFailGrabs", "numberOfFailQueries"]`.

docs/widgets/services/proxmox.md

@@ -3,6 +3,8 @@ title: Proxmox
 description: Proxmox Widget Configuration
 ---
 
+Learn more about [Proxmox](https://www.proxmox.com/en/).
+
 This widget shows the running and total counts of both QEMU VMs and LX Containers in the Proxmox cluster. It also shows the CPU and memory usage of the first node in the cluster.
 
 You will need to generate an API Token for new or an existing user. Here is an example of how to do this for a new user.

docs/widgets/services/proxmoxbackupserver.md

@@ -3,6 +3,8 @@ title: Proxmox Backup Server
 description: Proxmox Backup Server Widget Configuration
 ---
 
+Learn more about [Proxmox Backup Server](https://www.proxmox.com/en/proxmox-backup-server/overview).
+
 Allowed fields: `["datastore_usage", "failed_tasks_24h", "cpu_usage", "memory_usage"]`.
 
 ```yaml

docs/widgets/services/pterodactyl.md

@@ -3,6 +3,8 @@ title: Pterodactyl
 description: Pterodactyl Widget Configuration
 ---
 
+Learn more about [Pterodactyl](https://github.com/pterodactyl).
+
 Allowed fields: `["nodes", "servers"]`
 
 ```yaml

docs/widgets/services/pyload.md

@@ -3,6 +3,8 @@ title: Pyload
 description: Pyload Widget Configuration
 ---
 
+Learn more about [Pyload](https://github.com/pyload/pyload).
+
 Allowed fields: `["speed", "active", "queue", "total"]`.
 
 ```yaml

docs/widgets/services/qbittorrent.md

@@ -3,6 +3,8 @@ title: qBittorrent
 description: qBittorrent Widget Configuration
 ---
 
+Learn more about [qBittorrent](https://github.com/qbittorrent/qBittorrent).
+
 Uses the same username and password used to login from the web.
 
 Allowed fields: `["leech", "download", "seed", "upload"]`.

docs/widgets/services/qnap.md

@@ -3,6 +3,8 @@ title: QNAP
 description: QNAP Widget Configuration
 ---
 
+Learn more about [QNAP](https://www.qnap.com).
+
 Allowed fields: `["cpuUsage", "memUsage", "systemTempC", "poolUsage", "volumeUsage"]`.
 
 ```yaml

docs/widgets/services/radarr.md

@@ -3,6 +3,8 @@ title: Radarr
 description: Radarr Widget Configuration
 ---
 
+Learn more about [Radarr](https://github.com/Radarr/Radarr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["wanted", "missing", "queued", "movies"]`.

docs/widgets/services/readarr.md

@@ -3,6 +3,8 @@ title: Readarr
 description: Readarr Widget Configuration
 ---
 
+Learn more about [Readarr](https://github.com/Readarr/Readarr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["wanted", "queued", "books"]`.

docs/widgets/services/romm.md

@@ -0,0 +1,14 @@
+---
+title: Romm
+description: Romm Widget Configuration
+---
+
+Allowed fields: `["platforms", "totalRoms"]`.
+
+```yaml
+widget:
+  type: romm
+  url: http://romm.host.or.ip
+  username: username # optional
+  password: password # optional
+```

docs/widgets/services/rutorrent.md

@@ -3,6 +3,8 @@ title: ruTorrent
 description: ruTorrent Widget Configuration
 ---
 
+Learn more about [ruTorrent](https://github.com/Novik/ruTorrent).
+
 This requires the `httprpc` plugin to be installed and enabled, and is part of the default ruTorrent plugins. If you have not explicitly removed or disable this plugin, it should be available.
 
 Allowed fields: `["active", "upload", "download"]`.

docs/widgets/services/sabnzbd.md

@@ -3,6 +3,8 @@ title: SABnzbd
 description: SABnzbd Widget Configuration
 ---
 
+Learn more about [SABnzbd](https://github.com/sabnzbd/sabnzbd).
+
 Find your API key under `Config > General`.
 
 Allowed fields: `["rate", "queue", "timeleft"]`.

docs/widgets/services/scrutiny.md

@@ -3,6 +3,8 @@ title: Scrutiny
 description: Scrutiny Widget Configuration
 ---
 
+Learn more about [Scrutiny](https://github.com/AnalogJ/scrutiny).
+
 Allowed fields: `["passed", "failed", "unknown"]`.
 
 ```yaml

docs/widgets/services/sonarr.md

@@ -3,6 +3,8 @@ title: Sonarr
 description: Sonarr Widget Configuration
 ---
 
+Learn more about [Sonarr](https://github.com/Sonarr/Sonarr).
+
 Find your API key under `Settings > General`.
 
 Allowed fields: `["wanted", "queued", "series"]`.