mirror of
https://github.com/karl0ss/homepage.git
synced 2025-05-01 21:13:39 +01:00
Documentation: add project links to service widget docs (#2737)
This commit is contained in:
parent
e803c3bf16
commit
5d550b8597
@ -3,6 +3,8 @@ title: Adguard Home
|
||||
description: Adguard Home Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Atsumeru
|
||||
description: Atsumeru Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Audiobookshelf
|
||||
description: Audiobookshelf Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`
|
||||
|
@ -3,6 +3,8 @@ title: Authentik
|
||||
description: Authentik Widget Configuration
|
||||
---
|
||||
|
||||
[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:
|
||||
|
@ -3,6 +3,8 @@ title: Autobrr
|
||||
description: Autobrr Widget Configuration
|
||||
---
|
||||
|
||||
[Autobrr](https://github.com/autobrr/autobrr)
|
||||
|
||||
Find your API key under `Settings > API Keys`.
|
||||
|
||||
Allowed fields: `["approvedPushes", "rejectedPushes", "filters", "indexers"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Azure DevOps
|
||||
description: Azure DevOps Widget Configuration
|
||||
---
|
||||
|
||||
[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.\
|
||||
|
@ -3,6 +3,8 @@ title: Bazarr
|
||||
description: Bazarr Widget Configuration
|
||||
---
|
||||
|
||||
[Bazarr](https://github.com/morpheus65535/bazarr)
|
||||
|
||||
Find your API key under `Settings > General`.
|
||||
|
||||
Allowed fields: `["missingEpisodes", "missingMovies"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Caddy
|
||||
description: Caddy Widget Configuration
|
||||
---
|
||||
|
||||
[Caddy](https://github.com/caddyserver/caddy)
|
||||
|
||||
Allowed fields: `["upstreams", "requests", "requests_failed"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Calibre-web
|
||||
description: Calibre-web Widget Configuration
|
||||
---
|
||||
|
||||
[Calibre-web](https://github.com/janeczku/calibre-web)
|
||||
|
||||
**Note: widget requires calibre-web ≥ v0.6.21.**
|
||||
|
||||
Allowed fields: `["books", "authors", "categories", "series"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Changedetection.io
|
||||
description: Changedetection.io Widget Configuration
|
||||
---
|
||||
|
||||
[Changedetection.io](https://github.com/dgtlmoon/changedetection.io)
|
||||
|
||||
Find your API key under `Settings > API`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Channels DVR Server
|
||||
description: Channels DVR Server Widget Configuration
|
||||
---
|
||||
|
||||
[Channels DVR Server](https://getchannels.com/dvr-server/)
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: channelsdvrserver
|
||||
|
@ -3,6 +3,8 @@ title: Cloudflare Tunnels
|
||||
description: Cloudflare Tunnels Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Coin Market Cap
|
||||
description: Coin Market Cap Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: Deluge
|
||||
description: Deluge Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Synology Disk Station
|
||||
description: Synology Disk Station Widget Configuration
|
||||
---
|
||||
|
||||
[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).
|
||||
|
@ -3,6 +3,8 @@ title: Synology Download Station
|
||||
description: Synology Download Station Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Emby
|
||||
description: Emby Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: EVCC
|
||||
description: EVCC Widget Configuration
|
||||
---
|
||||
|
||||
[EVSS](https://github.com/evcc-io/evcc)
|
||||
|
||||
Allowed fields: `["pv_power", "grid_power", "home_power", "charge_power]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Fileflows
|
||||
description: Fileflows Widget Configuration
|
||||
---
|
||||
|
||||
[FileFlows](https://github.com/revenz/FileFlows)
|
||||
|
||||
Allowed fields: `["queue", "processing", "processed", "time"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Flood
|
||||
description: Flood Widget Configuration
|
||||
---
|
||||
|
||||
[Flood](https://github.com/jesec/flood)
|
||||
|
||||
Allowed fields: `["leech", "download", "seed", "upload"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: FreshRSS
|
||||
description: FreshRSS Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: GameDig
|
||||
description: GameDig Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Ghostfolio
|
||||
description: Ghostfolio Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
||||
```
|
||||
|
@ -3,6 +3,8 @@ title: Glances
|
||||
description: Glances Widget Configuration
|
||||
---
|
||||
|
||||
[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))_
|
||||
|
@ -3,6 +3,8 @@ title: Gluetun
|
||||
description: Gluetun Widget Configuration
|
||||
---
|
||||
|
||||
[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`.
|
||||
|
@ -3,6 +3,8 @@ title: Gotify
|
||||
description: Gotify Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Grafana
|
||||
description: Grafana Widget Configuration
|
||||
---
|
||||
|
||||
[Grafana](https://github.com/grafana/grafana)
|
||||
|
||||
Allowed fields: `["dashboards", "datasources", "totalalerts", "alertstriggered"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: HDHomerun
|
||||
description: HDHomerun Widget Configuration
|
||||
---
|
||||
|
||||
[HDHomerun](https://www.silicondust.com/support/downloads/)
|
||||
|
||||
Allowed fields: `["channels", "hd"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Health checks
|
||||
description: Health checks Widget Configuration
|
||||
---
|
||||
|
||||
[Health Checks](https://github.com/healthchecks/healthchecks)
|
||||
|
||||
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.
|
||||
|
||||
|
@ -3,6 +3,8 @@ title: Home Assistant
|
||||
description: Home Assistant Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Homebridge
|
||||
description: Homebridge
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Immich
|
||||
description: Immich Widget Configuration
|
||||
---
|
||||
|
||||
[Immich](https://github.com/immich-app/immich)
|
||||
|
||||
Find your API key under `Account Settings > API Keys`.
|
||||
|
||||
Allowed fields: `["users" ,"photos", "videos", "storage"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Jackett
|
||||
description: Jackett Widget Configuration
|
||||
---
|
||||
|
||||
[Jackett](https://github.com/Jackett/Jackett)
|
||||
|
||||
Jackett must not have any authentication for the widget to work.
|
||||
|
||||
Allowed fields: `["configured", "errored"]`.
|
||||
|
@ -3,6 +3,8 @@ title: JDownloader
|
||||
description: NextPVR Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Jellyfin
|
||||
description: Jellyfin Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: Jellyseerr
|
||||
description: Jellyseerr Widget Configuration
|
||||
---
|
||||
|
||||
[Jellyseerr](https://github.com/Fallenbagel/jellyseerr)
|
||||
|
||||
Find your API key under `Settings > General > API Key`.
|
||||
|
||||
Allowed fields: `["pending", "approved", "available"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Kavita
|
||||
description: Kavita Widget Configuration
|
||||
---
|
||||
|
||||
[Kavita](https://github.com/Kareadita/Kavita)
|
||||
|
||||
Uses the same username and password used to login from the web.
|
||||
|
||||
Allowed fields: `["seriesCount", "totalFiles"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Komga
|
||||
description: Komga Widget Configuration
|
||||
---
|
||||
|
||||
[Komga](https://github.com/gotson/komga)
|
||||
|
||||
Uses the same username and password used to login from the web.
|
||||
|
||||
Allowed fields: `["libraries", "series", "books"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Kopia
|
||||
description: Kopia Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: Lidarr
|
||||
description: Lidarr Widget Configuration
|
||||
---
|
||||
|
||||
[Lidarr](https://github.com/Lidarr/Lidarr)
|
||||
|
||||
Find your API key under `Settings > General`.
|
||||
|
||||
Allowed fields: `["wanted", "queued", "artists"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Mastodon
|
||||
description: Mastodon Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Mealie
|
||||
description: Mealie Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Medusa
|
||||
description: Medusa Widget Configuration
|
||||
---
|
||||
|
||||
[Medusa](https://github.com/medusajs/medusa)
|
||||
|
||||
Allowed fields: `["wanted", "queued", "series"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Miniflux
|
||||
description: Miniflux Widget Configuration
|
||||
---
|
||||
|
||||
[Miniflux](https://github.com/miniflux/v2)
|
||||
|
||||
Api key is found under Settings > API keys
|
||||
|
||||
Allowed fields: `["unread", "read"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Moonraker (Klipper)
|
||||
description: Moonraker (Klipper) Widget Configuration
|
||||
---
|
||||
|
||||
[Moonraker](https://github.com/Arksine/moonraker)
|
||||
|
||||
Allowed fields: `["printer_state", "print_status", "print_progress", "layers"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Mylar3
|
||||
description: Mylar3 Widget Configuration
|
||||
---
|
||||
|
||||
[Mylar3](https://github.com/mylar3/mylar3)
|
||||
|
||||
API must be enabled in Mylar3 settings.
|
||||
|
||||
Allowed fields: `["series", "issues", "wanted"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Navidrome
|
||||
description: Navidrome Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: Netdata
|
||||
description: Netdata Widget Configuration
|
||||
---
|
||||
|
||||
[Netdata](https://github.com/netdata/netdata)
|
||||
|
||||
Allowed fields: `["warnings", "criticals"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Nextcloud
|
||||
description: Nextcloud Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: NextDNS
|
||||
description: NextDNS Widget Configuration
|
||||
---
|
||||
|
||||
[NextDNS](https://nextdns.io/)
|
||||
|
||||
Api key is found under Account > API, profile ID is found under Setup > Endpoints > ID
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Nginx Proxy Manager
|
||||
description: Nginx Proxy Manager Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: NZBget
|
||||
description: NZBget Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: OctoPrint
|
||||
description: OctoPrintWidget Configuration
|
||||
---
|
||||
|
||||
[OctoPrint](https://octoprint.org/)
|
||||
|
||||
Allowed fields: `["printer_state", "temp_tool", "temp_bed", "job_completion"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Ombi
|
||||
description: Ombi Widget Configuration
|
||||
---
|
||||
|
||||
[Ombi](https://github.com/Ombi-app/Ombi)
|
||||
|
||||
Find your API key under `Settings > Configuration > General`.
|
||||
|
||||
Allowed fields: `["pending", "approved", "available"]`.
|
||||
|
@ -3,6 +3,8 @@ title: OpenDTU
|
||||
description: OpenDTU Widget
|
||||
---
|
||||
|
||||
[OpenDTU](https://github.com/tbnobody/OpenDTU)
|
||||
|
||||
Allowed fields: `["yieldDay", "relativePower", "absolutePower", "limit"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: OpenMediaVault
|
||||
description: OpenMediaVault Widget Configuration
|
||||
---
|
||||
|
||||
[OpenMediaVault](https://www.openmediavault.org/)
|
||||
|
||||
Provides useful information from your OpenMediaVault
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: OPNSense
|
||||
description: OPNSense Widget Configuration
|
||||
---
|
||||
|
||||
[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
|
||||
|
@ -3,6 +3,8 @@ title: Overseerr
|
||||
description: Overseerr Widget Configuration
|
||||
---
|
||||
|
||||
[Overseerr](https://github.com/sct/overseerr)
|
||||
|
||||
Find your API key under `Settings > General`.
|
||||
|
||||
Allowed fields: `["pending", "approved", "available", "processing"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Paperless-ngx
|
||||
description: Paperless-ngx Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: PeaNUT
|
||||
description: PeaNUT Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: pfSense
|
||||
description: pfSense Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: PhotoPrism
|
||||
description: PhotoPrism Widget Configuration
|
||||
---
|
||||
|
||||
[PhotoPrism](https://github.com/photoprism/photoprism).
|
||||
|
||||
Allowed fields: `["albums", "photos", "videos", "people"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: PiAlert
|
||||
description: PiAlert Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: PiHole
|
||||
description: PiHole Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Tautulli (Plex)
|
||||
description: Tautulli Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: Plex
|
||||
description: Plex Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Portainer
|
||||
description: Portainer Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Prometheus
|
||||
description: Prometheus Widget Configuration
|
||||
---
|
||||
|
||||
[Prometheus](https://github.com/prometheus/prometheus)
|
||||
|
||||
Allowed fields: `["targets_up", "targets_down", "targets_total"]`
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Prowlarr
|
||||
description: Prowlarr Widget Configuration
|
||||
---
|
||||
|
||||
[Prowlarr](https://github.com/Prowlarr/Prowlarr)
|
||||
|
||||
Find your API key under `Settings > General`.
|
||||
|
||||
Allowed fields: `["numberOfGrabs", "numberOfQueries", "numberOfFailGrabs", "numberOfFailQueries"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Proxmox
|
||||
description: Proxmox Widget Configuration
|
||||
---
|
||||
|
||||
[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.
|
||||
|
@ -3,6 +3,8 @@ title: Proxmox Backup Server
|
||||
description: Proxmox Backup Server Widget Configuration
|
||||
---
|
||||
|
||||
[Proxmox Backup Server](https://www.proxmox.com/en/proxmox-backup-server/overview)
|
||||
|
||||
Allowed fields: `["datastore_usage", "failed_tasks_24h", "cpu_usage", "memory_usage"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Pterodactyl
|
||||
description: Pterodactyl Widget Configuration
|
||||
---
|
||||
|
||||
[Pterodactyl](https://github.com/pterodactyl)
|
||||
|
||||
Allowed fields: `["nodes", "servers"]`
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Pyload
|
||||
description: Pyload Widget Configuration
|
||||
---
|
||||
|
||||
[Pyload](https://github.com/pyload/pyload)
|
||||
|
||||
Allowed fields: `["speed", "active", "queue", "total"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: qBittorrent
|
||||
description: qBittorrent Widget Configuration
|
||||
---
|
||||
|
||||
[qBittorrent](https://github.com/qbittorrent/qBittorrent)
|
||||
|
||||
Uses the same username and password used to login from the web.
|
||||
|
||||
Allowed fields: `["leech", "download", "seed", "upload"]`.
|
||||
|
@ -3,6 +3,8 @@ title: QNAP
|
||||
description: QNAP Widget Configuration
|
||||
---
|
||||
|
||||
[QNAP](https://www.qnap.com)
|
||||
|
||||
Allowed fields: `["cpuUsage", "memUsage", "systemTempC", "poolUsage", "volumeUsage"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Radarr
|
||||
description: Radarr Widget Configuration
|
||||
---
|
||||
|
||||
[Radarr](https://github.com/Radarr/Radarr)
|
||||
|
||||
Find your API key under `Settings > General`.
|
||||
|
||||
Allowed fields: `["wanted", "missing", "queued", "movies"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Readarr
|
||||
description: Readarr Widget Configuration
|
||||
---
|
||||
|
||||
[Readarr](https://github.com/Readarr/Readarr)
|
||||
|
||||
Find your API key under `Settings > General`.
|
||||
|
||||
Allowed fields: `["wanted", "queued", "books"]`.
|
||||
|
@ -3,6 +3,8 @@ title: ruTorrent
|
||||
description: ruTorrent Widget Configuration
|
||||
---
|
||||
|
||||
[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"]`.
|
||||
|
@ -3,6 +3,8 @@ title: SABnzbd
|
||||
description: SABnzbd Widget Configuration
|
||||
---
|
||||
|
||||
[SABnzbd](https://github.com/sabnzbd/sabnzbd)
|
||||
|
||||
Find your API key under `Config > General`.
|
||||
|
||||
Allowed fields: `["rate", "queue", "timeleft"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Scrutiny
|
||||
description: Scrutiny Widget Configuration
|
||||
---
|
||||
|
||||
[Scrutiny](https://github.com/AnalogJ/scrutiny)
|
||||
|
||||
Allowed fields: `["passed", "failed", "unknown"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Sonarr
|
||||
description: Sonarr Widget Configuration
|
||||
---
|
||||
|
||||
[Sonarr](https://github.com/Sonarr/Sonarr)
|
||||
|
||||
Find your API key under `Settings > General`.
|
||||
|
||||
Allowed fields: `["wanted", "queued", "series"]`.
|
||||
|
@ -3,6 +3,9 @@ title: Speedtest Tracker
|
||||
description: Speedtest Tracker Widget Configuration
|
||||
---
|
||||
|
||||
[Speedtest Tracker](https://github.com/alexjustesen/speedtest-tracker) or
|
||||
[Speedtest Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker)
|
||||
|
||||
No extra configuration is required.
|
||||
|
||||
This widget is compatible with both [alexjustesen/speedtest-tracker](https://github.com/alexjustesen/speedtest-tracker) and [henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker).
|
||||
|
@ -3,6 +3,8 @@ title: Syncthing Relay Server
|
||||
description: Syncthing Relay Server Widget Configuration
|
||||
---
|
||||
|
||||
[Syncthing Relay Server](https://github.com/syncthing/syncthing)
|
||||
|
||||
Pulls stats from the [relay server](https://docs.syncthing.net/users/strelaysrv.html). [See here](https://github.com/gethomepage/homepage/pull/230#issuecomment-1253053472) for more information on configuration.
|
||||
|
||||
Allowed fields: `["numActiveSessions", "numConnections", "bytesProxied"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Tailscale
|
||||
description: Tailscale Widget Configuration
|
||||
---
|
||||
|
||||
[Tailscale](https://github.com/tailscale/tailscale)
|
||||
|
||||
You will need to generate an API access token from the [keys page](https://login.tailscale.com/admin/settings/keys) on the Tailscale dashboard.
|
||||
|
||||
To find your device ID, go to the [machine overview page](https://login.tailscale.com/admin/machines) and select your machine. In the "Machine Details" section, copy your `ID`. It will end with `CNTRL`.
|
||||
|
@ -3,6 +3,8 @@ title: Tdarr
|
||||
description: Tdarr Widget Configuration
|
||||
---
|
||||
|
||||
[Tdarr](https://github.com/HaveAGitGat/Tdarr)
|
||||
|
||||
Allowed fields: `["queue", "processed", "errored", "saved"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Traefik
|
||||
description: Traefik Widget Configuration
|
||||
---
|
||||
|
||||
[Traefik](https://github.com/traefik/traefik)
|
||||
|
||||
No extra configuration is required.
|
||||
If your traefik install requires authentication, include the username and password used to login to the web interface.
|
||||
|
||||
|
@ -3,6 +3,8 @@ title: Transmission
|
||||
description: Transmission Widget Configuration
|
||||
---
|
||||
|
||||
[Transmission](https://github.com/transmission/transmission)
|
||||
|
||||
Uses the same username and password used to login from the web.
|
||||
|
||||
Allowed fields: `["leech", "download", "seed", "upload"]`.
|
||||
|
@ -3,6 +3,8 @@ title: TrueNas
|
||||
description: TrueNas Scale Widget Configuration
|
||||
---
|
||||
|
||||
[TrueNas](https://www.truenas.com/)
|
||||
|
||||
Allowed fields: `["load", "uptime", "alerts"]`.
|
||||
|
||||
To create an API Key, follow [the official TrueNAS documentation](https://www.truenas.com/docs/scale/scaletutorials/toptoolbar/managingapikeys/).
|
||||
|
@ -3,6 +3,8 @@ title: Tube Archivist
|
||||
description: Tube Archivist Widget Configuration
|
||||
---
|
||||
|
||||
[Tube Archivist](https://github.com/tubearchivist/tubearchivist)
|
||||
|
||||
Requires API key.
|
||||
|
||||
Allowed fields: `["downloads", "videos", "channels", "playlists"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Unifi Controller
|
||||
description: Unifi Controller Widget Configuration
|
||||
---
|
||||
|
||||
[Unifi Controller](https://ui.com/)
|
||||
|
||||
_(Find the Unifi Controller information widget [here](../info/unifi_controller.md))_
|
||||
|
||||
You can display general connectivity status from your Unifi (Network) Controller. When authenticating you will want to use an account that has at least read privileges.
|
||||
|
@ -3,6 +3,8 @@ title: Unmanic
|
||||
description: Unmanic Widget Configuration
|
||||
---
|
||||
|
||||
[Unmanic](https://github.com/Unmanic/unmanic)
|
||||
|
||||
Allowed fields: `["active_workers", "total_workers", "records_total"]`.
|
||||
|
||||
```yaml
|
||||
|
@ -3,6 +3,8 @@ title: Uptime Kuma
|
||||
description: Uptime Kuma Widget Configuration
|
||||
---
|
||||
|
||||
[Uptime Kuma](https://github.com/louislam/uptime-kuma)
|
||||
|
||||
As Uptime Kuma does not yet have a full API the widget uses data from a single "status page". As such you will need a status page setup with a group of monitored sites, which is where you get the slug (without the `/status/` portion).
|
||||
|
||||
Allowed fields: `["up", "down", "uptime", "incident"]`.
|
||||
|
@ -3,6 +3,8 @@ title: UptimeRobot
|
||||
description: UptimeRobot Widget Configuration
|
||||
---
|
||||
|
||||
[UptimeRobot](https://uptimerobot.com/)
|
||||
|
||||
To generate an API key, select `My Settings`, and either `Monitor-Specific API Key` or `Read-Only API Key`.
|
||||
|
||||
A `Monitor-Specific API Key` will provide the following detailed information
|
||||
|
@ -3,6 +3,8 @@ title: UrBackup
|
||||
description: UrBackup Widget Configuration
|
||||
---
|
||||
|
||||
[UrBackup](https://github.com/uroni/urbackup_backend)
|
||||
|
||||
The UrBackup widget retrieves the total number of clients that currently have no errors, have errors, or haven't backed up recently. Clients are considered "Errored" or "Out of Date" if either the file or image backups for that client have errors/are out of date, unless the client does not support image backups.
|
||||
|
||||
The default number of days that can elapse before a client is marked Out of Date is 3, but this value can be customized by setting the `maxDays` value in the config.
|
||||
|
@ -3,6 +3,8 @@ title: Watchtower
|
||||
description: Watchtower Widget Configuration
|
||||
---
|
||||
|
||||
[Watchtower](https://github.com/containrrr/watchtower)
|
||||
|
||||
To use this widget, Watchtower needs to be configured to to [enable metrics](https://containrrr.dev/watchtower/metrics/).
|
||||
|
||||
Allowed fields: `["containers_scanned", "containers_updated", "containers_failed"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Whats Up Docker
|
||||
description: WhatsUpDocker Widget Configuration
|
||||
---
|
||||
|
||||
[Whats Up Docker](https://github.com/fmartinou/whats-up-docker)
|
||||
|
||||
Currently requires unauthenticated whatsupdocker instance.
|
||||
|
||||
Allowed fields: `["monitoring", "updates"]`.
|
||||
|
@ -3,6 +3,8 @@ title: Xteve
|
||||
description: Xteve Widget Configuration
|
||||
---
|
||||
|
||||
[Xteve](https://github.com/xteve-project/xTeVe)
|
||||
|
||||
Allowed fields: `["streams_all", "streams_active", "streams_xepg"]`.
|
||||
|
||||
```yaml
|
||||
|
Loading…
x
Reference in New Issue
Block a user