From 5d550b85972d8a9b2817a1b1c8e36e5e49403dff Mon Sep 17 00:00:00 2001 From: Tharic99 <39832147+Tharic99@users.noreply.github.com> Date: Mon, 22 Jan 2024 13:26:15 -0500 Subject: [PATCH] Documentation: add project links to service widget docs (#2737) --- docs/widgets/services/adguard-home.md | 2 ++ docs/widgets/services/atsumeru.md | 2 ++ docs/widgets/services/audiobookshelf.md | 2 ++ docs/widgets/services/authentik.md | 2 ++ docs/widgets/services/autobrr.md | 2 ++ docs/widgets/services/azuredevops.md | 2 ++ docs/widgets/services/bazarr.md | 2 ++ docs/widgets/services/caddy.md | 2 ++ docs/widgets/services/calibre-web.md | 2 ++ docs/widgets/services/changedetectionio.md | 2 ++ docs/widgets/services/channelsdvrserver.md | 2 ++ docs/widgets/services/cloudflared.md | 2 ++ docs/widgets/services/coin-market-cap.md | 2 ++ docs/widgets/services/deluge.md | 2 ++ docs/widgets/services/diskstation.md | 2 ++ docs/widgets/services/downloadstation.md | 2 ++ docs/widgets/services/emby.md | 2 ++ docs/widgets/services/evcc.md | 2 ++ docs/widgets/services/fileflows.md | 2 ++ docs/widgets/services/flood.md | 2 ++ docs/widgets/services/freshrss.md | 2 ++ docs/widgets/services/gamedig.md | 2 ++ docs/widgets/services/ghostfolio.md | 2 ++ docs/widgets/services/glances.md | 2 ++ docs/widgets/services/gluetun.md | 2 ++ docs/widgets/services/gotify.md | 2 ++ docs/widgets/services/grafana.md | 2 ++ docs/widgets/services/hdhomerun.md | 2 ++ docs/widgets/services/healthchecks.md | 2 ++ docs/widgets/services/homeassistant.md | 2 ++ docs/widgets/services/homebridge.md | 2 ++ docs/widgets/services/immich.md | 2 ++ docs/widgets/services/jackett.md | 2 ++ docs/widgets/services/jdownloader.md | 2 ++ docs/widgets/services/jellyfin.md | 2 ++ docs/widgets/services/jellyseerr.md | 2 ++ docs/widgets/services/kavita.md | 2 ++ docs/widgets/services/komga.md | 2 ++ docs/widgets/services/kopia.md | 2 ++ docs/widgets/services/lidarr.md | 2 ++ docs/widgets/services/mastodon.md | 2 ++ docs/widgets/services/mealie.md | 2 ++ docs/widgets/services/medusa.md | 2 ++ docs/widgets/services/miniflux.md | 2 ++ docs/widgets/services/moonraker.md | 2 ++ docs/widgets/services/mylar.md | 2 ++ docs/widgets/services/navidrome.md | 2 ++ docs/widgets/services/netdata.md | 2 ++ docs/widgets/services/nextcloud.md | 2 ++ docs/widgets/services/nextdns.md | 2 ++ docs/widgets/services/nginx-proxy-manager.md | 2 ++ docs/widgets/services/nzbget.md | 2 ++ docs/widgets/services/octoprint.md | 2 ++ docs/widgets/services/ombi.md | 2 ++ docs/widgets/services/opendtu.md | 2 ++ docs/widgets/services/openmediavault.md | 2 ++ docs/widgets/services/opnsense.md | 2 ++ docs/widgets/services/overseerr.md | 2 ++ docs/widgets/services/paperlessngx.md | 2 ++ docs/widgets/services/peanut.md | 2 ++ docs/widgets/services/pfsense.md | 2 ++ docs/widgets/services/photoprism.md | 2 ++ docs/widgets/services/pialert.md | 2 ++ docs/widgets/services/pihole.md | 2 ++ docs/widgets/services/plex-tautulli.md | 2 ++ docs/widgets/services/plex.md | 2 ++ docs/widgets/services/portainer.md | 2 ++ docs/widgets/services/prometheus.md | 2 ++ docs/widgets/services/prowlarr.md | 2 ++ docs/widgets/services/proxmox.md | 2 ++ docs/widgets/services/proxmoxbackupserver.md | 2 ++ docs/widgets/services/pterodactyl.md | 2 ++ docs/widgets/services/pyload.md | 2 ++ docs/widgets/services/qbittorrent.md | 2 ++ docs/widgets/services/qnap.md | 2 ++ docs/widgets/services/radarr.md | 2 ++ docs/widgets/services/readarr.md | 2 ++ docs/widgets/services/rutorrent.md | 2 ++ docs/widgets/services/sabnzbd.md | 2 ++ docs/widgets/services/scrutiny.md | 2 ++ docs/widgets/services/sonarr.md | 2 ++ docs/widgets/services/speedtest-tracker.md | 3 +++ docs/widgets/services/syncthing-relay-server.md | 2 ++ docs/widgets/services/tailscale.md | 2 ++ docs/widgets/services/tdarr.md | 2 ++ docs/widgets/services/traefik.md | 2 ++ docs/widgets/services/transmission.md | 2 ++ docs/widgets/services/truenas.md | 2 ++ docs/widgets/services/tubearchivist.md | 2 ++ docs/widgets/services/unifi-controller.md | 2 ++ docs/widgets/services/unmanic.md | 2 ++ docs/widgets/services/uptime-kuma.md | 2 ++ docs/widgets/services/uptimerobot.md | 2 ++ docs/widgets/services/urbackup.md | 2 ++ docs/widgets/services/watchtower.md | 2 ++ docs/widgets/services/whatsupdocker.md | 2 ++ docs/widgets/services/xteve.md | 2 ++ 97 files changed, 195 insertions(+) diff --git a/docs/widgets/services/adguard-home.md b/docs/widgets/services/adguard-home.md index af922f77f6a..ad1cf214cad 100644 --- a/docs/widgets/services/adguard-home.md +++ b/docs/widgets/services/adguard-home.md @@ -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"]`. diff --git a/docs/widgets/services/atsumeru.md b/docs/widgets/services/atsumeru.md index 77432216804..b8382d3e309 100644 --- a/docs/widgets/services/atsumeru.md +++ b/docs/widgets/services/atsumeru.md @@ -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"]`. diff --git a/docs/widgets/services/audiobookshelf.md b/docs/widgets/services/audiobookshelf.md index 10beec24928..8e8f099d795 100644 --- a/docs/widgets/services/audiobookshelf.md +++ b/docs/widgets/services/audiobookshelf.md @@ -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"]` diff --git a/docs/widgets/services/authentik.md b/docs/widgets/services/authentik.md index b3f8cdd6dd2..ef1b2e80d7f 100644 --- a/docs/widgets/services/authentik.md +++ b/docs/widgets/services/authentik.md @@ -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: diff --git a/docs/widgets/services/autobrr.md b/docs/widgets/services/autobrr.md index d41d7c324bc..8b22eac6126 100644 --- a/docs/widgets/services/autobrr.md +++ b/docs/widgets/services/autobrr.md @@ -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"]`. diff --git a/docs/widgets/services/azuredevops.md b/docs/widgets/services/azuredevops.md index 86ad741882d..1179ca72c67 100644 --- a/docs/widgets/services/azuredevops.md +++ b/docs/widgets/services/azuredevops.md @@ -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.\ diff --git a/docs/widgets/services/bazarr.md b/docs/widgets/services/bazarr.md index ac1a95c8e46..886f0b15dc6 100644 --- a/docs/widgets/services/bazarr.md +++ b/docs/widgets/services/bazarr.md @@ -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"]`. diff --git a/docs/widgets/services/caddy.md b/docs/widgets/services/caddy.md index c85d1d9add7..3f028893287 100644 --- a/docs/widgets/services/caddy.md +++ b/docs/widgets/services/caddy.md @@ -3,6 +3,8 @@ title: Caddy description: Caddy Widget Configuration --- +[Caddy](https://github.com/caddyserver/caddy) + Allowed fields: `["upstreams", "requests", "requests_failed"]`. ```yaml diff --git a/docs/widgets/services/calibre-web.md b/docs/widgets/services/calibre-web.md index 454e3105535..c78855148ee 100644 --- a/docs/widgets/services/calibre-web.md +++ b/docs/widgets/services/calibre-web.md @@ -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"]`. diff --git a/docs/widgets/services/changedetectionio.md b/docs/widgets/services/changedetectionio.md index 060043fdecf..e2d8b340a42 100644 --- a/docs/widgets/services/changedetectionio.md +++ b/docs/widgets/services/changedetectionio.md @@ -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 diff --git a/docs/widgets/services/channelsdvrserver.md b/docs/widgets/services/channelsdvrserver.md index 59edaac526b..f6a2547462d 100644 --- a/docs/widgets/services/channelsdvrserver.md +++ b/docs/widgets/services/channelsdvrserver.md @@ -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 diff --git a/docs/widgets/services/cloudflared.md b/docs/widgets/services/cloudflared.md index 663d0d6ea89..2e469256748 100644 --- a/docs/widgets/services/cloudflared.md +++ b/docs/widgets/services/cloudflared.md @@ -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"]`. diff --git a/docs/widgets/services/coin-market-cap.md b/docs/widgets/services/coin-market-cap.md index df865047ab5..9bb8aaedeea 100644 --- a/docs/widgets/services/coin-market-cap.md +++ b/docs/widgets/services/coin-market-cap.md @@ -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. diff --git a/docs/widgets/services/deluge.md b/docs/widgets/services/deluge.md index 9408ea2a6c0..620058e9ce2 100644 --- a/docs/widgets/services/deluge.md +++ b/docs/widgets/services/deluge.md @@ -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"]`. diff --git a/docs/widgets/services/diskstation.md b/docs/widgets/services/diskstation.md index 29936d30ee5..6786dca9904 100644 --- a/docs/widgets/services/diskstation.md +++ b/docs/widgets/services/diskstation.md @@ -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). diff --git a/docs/widgets/services/downloadstation.md b/docs/widgets/services/downloadstation.md index 22bb8da9818..88230fe040d 100644 --- a/docs/widgets/services/downloadstation.md +++ b/docs/widgets/services/downloadstation.md @@ -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"]`. diff --git a/docs/widgets/services/emby.md b/docs/widgets/services/emby.md index fb922d76e44..71b33b99c2f 100644 --- a/docs/widgets/services/emby.md +++ b/docs/widgets/services/emby.md @@ -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. diff --git a/docs/widgets/services/evcc.md b/docs/widgets/services/evcc.md index a3b95ba73e7..45af308c59e 100644 --- a/docs/widgets/services/evcc.md +++ b/docs/widgets/services/evcc.md @@ -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 diff --git a/docs/widgets/services/fileflows.md b/docs/widgets/services/fileflows.md index 2679cbd7f84..35367ae69d0 100644 --- a/docs/widgets/services/fileflows.md +++ b/docs/widgets/services/fileflows.md @@ -3,6 +3,8 @@ title: Fileflows description: Fileflows Widget Configuration --- +[FileFlows](https://github.com/revenz/FileFlows) + Allowed fields: `["queue", "processing", "processed", "time"]`. ```yaml diff --git a/docs/widgets/services/flood.md b/docs/widgets/services/flood.md index 8585fedb3b6..0ec9688092a 100644 --- a/docs/widgets/services/flood.md +++ b/docs/widgets/services/flood.md @@ -3,6 +3,8 @@ title: Flood description: Flood Widget Configuration --- +[Flood](https://github.com/jesec/flood) + Allowed fields: `["leech", "download", "seed", "upload"]`. ```yaml diff --git a/docs/widgets/services/freshrss.md b/docs/widgets/services/freshrss.md index d9e8834f63a..306f80c61bc 100644 --- a/docs/widgets/services/freshrss.md +++ b/docs/widgets/services/freshrss.md @@ -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"]`. diff --git a/docs/widgets/services/gamedig.md b/docs/widgets/services/gamedig.md index d287f69a572..009858305e6 100644 --- a/docs/widgets/services/gamedig.md +++ b/docs/widgets/services/gamedig.md @@ -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"]`. diff --git a/docs/widgets/services/ghostfolio.md b/docs/widgets/services/ghostfolio.md index 554e6843241..ada5f00566b 100644 --- a/docs/widgets/services/ghostfolio.md +++ b/docs/widgets/services/ghostfolio.md @@ -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. ``` diff --git a/docs/widgets/services/glances.md b/docs/widgets/services/glances.md index abd756a96c6..c119ee7387b 100644 --- a/docs/widgets/services/glances.md +++ b/docs/widgets/services/glances.md @@ -3,6 +3,8 @@ title: Glances description: Glances Widget Configuration --- +[Glances](https://github.com/nicolargo/glances) + glances _(Find the Glances information widget [here](../info/glances.md))_ diff --git a/docs/widgets/services/gluetun.md b/docs/widgets/services/gluetun.md index 362be0c3e51..54b71367162 100644 --- a/docs/widgets/services/gluetun.md +++ b/docs/widgets/services/gluetun.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`. diff --git a/docs/widgets/services/gotify.md b/docs/widgets/services/gotify.md index 871eefaaa48..6d6f48c4e73 100644 --- a/docs/widgets/services/gotify.md +++ b/docs/widgets/services/gotify.md @@ -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"]`. diff --git a/docs/widgets/services/grafana.md b/docs/widgets/services/grafana.md index bfdebb2cc36..3fc940beb0b 100644 --- a/docs/widgets/services/grafana.md +++ b/docs/widgets/services/grafana.md @@ -3,6 +3,8 @@ title: Grafana description: Grafana Widget Configuration --- +[Grafana](https://github.com/grafana/grafana) + Allowed fields: `["dashboards", "datasources", "totalalerts", "alertstriggered"]`. ```yaml diff --git a/docs/widgets/services/hdhomerun.md b/docs/widgets/services/hdhomerun.md index c862200e0d7..46277a1b921 100644 --- a/docs/widgets/services/hdhomerun.md +++ b/docs/widgets/services/hdhomerun.md @@ -3,6 +3,8 @@ title: HDHomerun description: HDHomerun Widget Configuration --- +[HDHomerun](https://www.silicondust.com/support/downloads/) + Allowed fields: `["channels", "hd"]`. ```yaml diff --git a/docs/widgets/services/healthchecks.md b/docs/widgets/services/healthchecks.md index b438e153015..7d622d4c149 100644 --- a/docs/widgets/services/healthchecks.md +++ b/docs/widgets/services/healthchecks.md @@ -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. diff --git a/docs/widgets/services/homeassistant.md b/docs/widgets/services/homeassistant.md index 8d8b04e95c1..cab1f8919ff 100644 --- a/docs/widgets/services/homeassistant.md +++ b/docs/widgets/services/homeassistant.md @@ -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"]`. diff --git a/docs/widgets/services/homebridge.md b/docs/widgets/services/homebridge.md index d71ca93be67..1d30f42a8e7 100644 --- a/docs/widgets/services/homebridge.md +++ b/docs/widgets/services/homebridge.md @@ -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"]`. diff --git a/docs/widgets/services/immich.md b/docs/widgets/services/immich.md index b6d286c4936..4ef2e5f2030 100644 --- a/docs/widgets/services/immich.md +++ b/docs/widgets/services/immich.md @@ -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"]`. diff --git a/docs/widgets/services/jackett.md b/docs/widgets/services/jackett.md index 91c58b28ded..707e1a53262 100644 --- a/docs/widgets/services/jackett.md +++ b/docs/widgets/services/jackett.md @@ -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"]`. diff --git a/docs/widgets/services/jdownloader.md b/docs/widgets/services/jdownloader.md index 31469fb9d5c..f40ded4632c 100644 --- a/docs/widgets/services/jdownloader.md +++ b/docs/widgets/services/jdownloader.md @@ -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"]`. diff --git a/docs/widgets/services/jellyfin.md b/docs/widgets/services/jellyfin.md index cc96178917d..33c0fddddbc 100644 --- a/docs/widgets/services/jellyfin.md +++ b/docs/widgets/services/jellyfin.md @@ -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. diff --git a/docs/widgets/services/jellyseerr.md b/docs/widgets/services/jellyseerr.md index f6e071d85b1..08bfd420b44 100644 --- a/docs/widgets/services/jellyseerr.md +++ b/docs/widgets/services/jellyseerr.md @@ -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"]`. diff --git a/docs/widgets/services/kavita.md b/docs/widgets/services/kavita.md index 59bc91d4aad..b01ededd417 100644 --- a/docs/widgets/services/kavita.md +++ b/docs/widgets/services/kavita.md @@ -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"]`. diff --git a/docs/widgets/services/komga.md b/docs/widgets/services/komga.md index a05f67d939d..62d303b3e0e 100644 --- a/docs/widgets/services/komga.md +++ b/docs/widgets/services/komga.md @@ -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"]`. diff --git a/docs/widgets/services/kopia.md b/docs/widgets/services/kopia.md index 00f1ff70139..bc9dab174a6 100644 --- a/docs/widgets/services/kopia.md +++ b/docs/widgets/services/kopia.md @@ -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. diff --git a/docs/widgets/services/lidarr.md b/docs/widgets/services/lidarr.md index b6c1e34b160..3923cf87543 100644 --- a/docs/widgets/services/lidarr.md +++ b/docs/widgets/services/lidarr.md @@ -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"]`. diff --git a/docs/widgets/services/mastodon.md b/docs/widgets/services/mastodon.md index 5a0ed703cc9..3144a4c61cb 100644 --- a/docs/widgets/services/mastodon.md +++ b/docs/widgets/services/mastodon.md @@ -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"]`. diff --git a/docs/widgets/services/mealie.md b/docs/widgets/services/mealie.md index cb7b957fbe8..c143247e08e 100644 --- a/docs/widgets/services/mealie.md +++ b/docs/widgets/services/mealie.md @@ -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"]`. diff --git a/docs/widgets/services/medusa.md b/docs/widgets/services/medusa.md index d9b37fed210..1e9866af155 100644 --- a/docs/widgets/services/medusa.md +++ b/docs/widgets/services/medusa.md @@ -3,6 +3,8 @@ title: Medusa description: Medusa Widget Configuration --- +[Medusa](https://github.com/medusajs/medusa) + Allowed fields: `["wanted", "queued", "series"]`. ```yaml diff --git a/docs/widgets/services/miniflux.md b/docs/widgets/services/miniflux.md index 0b1dfc87238..7e957215a42 100644 --- a/docs/widgets/services/miniflux.md +++ b/docs/widgets/services/miniflux.md @@ -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"]`. diff --git a/docs/widgets/services/moonraker.md b/docs/widgets/services/moonraker.md index e3374e6080e..ca139f494bc 100644 --- a/docs/widgets/services/moonraker.md +++ b/docs/widgets/services/moonraker.md @@ -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 diff --git a/docs/widgets/services/mylar.md b/docs/widgets/services/mylar.md index 9ec1397f995..361346dab79 100644 --- a/docs/widgets/services/mylar.md +++ b/docs/widgets/services/mylar.md @@ -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"]`. diff --git a/docs/widgets/services/navidrome.md b/docs/widgets/services/navidrome.md index bb57f635e8a..65b776a8300 100644 --- a/docs/widgets/services/navidrome.md +++ b/docs/widgets/services/navidrome.md @@ -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. diff --git a/docs/widgets/services/netdata.md b/docs/widgets/services/netdata.md index e6ed050f1f5..25421305c97 100644 --- a/docs/widgets/services/netdata.md +++ b/docs/widgets/services/netdata.md @@ -3,6 +3,8 @@ title: Netdata description: Netdata Widget Configuration --- +[Netdata](https://github.com/netdata/netdata) + Allowed fields: `["warnings", "criticals"]`. ```yaml diff --git a/docs/widgets/services/nextcloud.md b/docs/widgets/services/nextcloud.md index 1e9d53f9053..cb581f7db7e 100644 --- a/docs/widgets/services/nextcloud.md +++ b/docs/widgets/services/nextcloud.md @@ -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"]`. diff --git a/docs/widgets/services/nextdns.md b/docs/widgets/services/nextdns.md index b646c11db81..eea0639ad85 100644 --- a/docs/widgets/services/nextdns.md +++ b/docs/widgets/services/nextdns.md @@ -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 diff --git a/docs/widgets/services/nginx-proxy-manager.md b/docs/widgets/services/nginx-proxy-manager.md index dc201627a65..b133867eaf2 100644 --- a/docs/widgets/services/nginx-proxy-manager.md +++ b/docs/widgets/services/nginx-proxy-manager.md @@ -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"]`. diff --git a/docs/widgets/services/nzbget.md b/docs/widgets/services/nzbget.md index f069910a2fa..d459254d865 100644 --- a/docs/widgets/services/nzbget.md +++ b/docs/widgets/services/nzbget.md @@ -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"]`. diff --git a/docs/widgets/services/octoprint.md b/docs/widgets/services/octoprint.md index 7688e13faea..969dd3858d2 100644 --- a/docs/widgets/services/octoprint.md +++ b/docs/widgets/services/octoprint.md @@ -3,6 +3,8 @@ title: OctoPrint description: OctoPrintWidget Configuration --- +[OctoPrint](https://octoprint.org/) + Allowed fields: `["printer_state", "temp_tool", "temp_bed", "job_completion"]`. ```yaml diff --git a/docs/widgets/services/ombi.md b/docs/widgets/services/ombi.md index de2708d09c1..270dccc78df 100644 --- a/docs/widgets/services/ombi.md +++ b/docs/widgets/services/ombi.md @@ -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"]`. diff --git a/docs/widgets/services/opendtu.md b/docs/widgets/services/opendtu.md index 6a6111cce5c..6a7e1854dab 100644 --- a/docs/widgets/services/opendtu.md +++ b/docs/widgets/services/opendtu.md @@ -3,6 +3,8 @@ title: OpenDTU description: OpenDTU Widget --- +[OpenDTU](https://github.com/tbnobody/OpenDTU) + Allowed fields: `["yieldDay", "relativePower", "absolutePower", "limit"]`. ```yaml diff --git a/docs/widgets/services/openmediavault.md b/docs/widgets/services/openmediavault.md index 43ff2dea60a..ab6864f93bf 100644 --- a/docs/widgets/services/openmediavault.md +++ b/docs/widgets/services/openmediavault.md @@ -3,6 +3,8 @@ title: OpenMediaVault description: OpenMediaVault Widget Configuration --- +[OpenMediaVault](https://www.openmediavault.org/) + Provides useful information from your OpenMediaVault ```yaml diff --git a/docs/widgets/services/opnsense.md b/docs/widgets/services/opnsense.md index 5838cee60d8..fa66cb5cb2e 100644 --- a/docs/widgets/services/opnsense.md +++ b/docs/widgets/services/opnsense.md @@ -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 diff --git a/docs/widgets/services/overseerr.md b/docs/widgets/services/overseerr.md index 9c2055b3436..c8adb526815 100644 --- a/docs/widgets/services/overseerr.md +++ b/docs/widgets/services/overseerr.md @@ -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"]`. diff --git a/docs/widgets/services/paperlessngx.md b/docs/widgets/services/paperlessngx.md index be5f3af4cbc..fd64a3fd1a2 100644 --- a/docs/widgets/services/paperlessngx.md +++ b/docs/widgets/services/paperlessngx.md @@ -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"]`. diff --git a/docs/widgets/services/peanut.md b/docs/widgets/services/peanut.md index fa6cf6b366d..002d729135e 100644 --- a/docs/widgets/services/peanut.md +++ b/docs/widgets/services/peanut.md @@ -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. diff --git a/docs/widgets/services/pfsense.md b/docs/widgets/services/pfsense.md index 3c35c3be7ac..bb76ea2ca72 100644 --- a/docs/widgets/services/pfsense.md +++ b/docs/widgets/services/pfsense.md @@ -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. diff --git a/docs/widgets/services/photoprism.md b/docs/widgets/services/photoprism.md index 46bf112bf85..94a7d0431a7 100644 --- a/docs/widgets/services/photoprism.md +++ b/docs/widgets/services/photoprism.md @@ -3,6 +3,8 @@ title: PhotoPrism description: PhotoPrism Widget Configuration --- +[PhotoPrism](https://github.com/photoprism/photoprism). + Allowed fields: `["albums", "photos", "videos", "people"]`. ```yaml diff --git a/docs/widgets/services/pialert.md b/docs/widgets/services/pialert.md index 6c154322ccd..645180604e8 100644 --- a/docs/widgets/services/pialert.md +++ b/docs/widgets/services/pialert.md @@ -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"]`. diff --git a/docs/widgets/services/pihole.md b/docs/widgets/services/pihole.md index f0855932c71..0cb004b5bae 100644 --- a/docs/widgets/services/pihole.md +++ b/docs/widgets/services/pihole.md @@ -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"]`. diff --git a/docs/widgets/services/plex-tautulli.md b/docs/widgets/services/plex-tautulli.md index d6138b6bcb8..5e8fdcb6dd4 100644 --- a/docs/widgets/services/plex-tautulli.md +++ b/docs/widgets/services/plex-tautulli.md @@ -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. diff --git a/docs/widgets/services/plex.md b/docs/widgets/services/plex.md index 996d20b93d8..5f1d1955d88 100644 --- a/docs/widgets/services/plex.md +++ b/docs/widgets/services/plex.md @@ -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"]`. diff --git a/docs/widgets/services/portainer.md b/docs/widgets/services/portainer.md index 55e854b0dac..18a456a033d 100644 --- a/docs/widgets/services/portainer.md +++ b/docs/widgets/services/portainer.md @@ -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"]`. diff --git a/docs/widgets/services/prometheus.md b/docs/widgets/services/prometheus.md index 2b15d861a15..82fbecd000c 100644 --- a/docs/widgets/services/prometheus.md +++ b/docs/widgets/services/prometheus.md @@ -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 diff --git a/docs/widgets/services/prowlarr.md b/docs/widgets/services/prowlarr.md index 0b22b33b194..957fa71ccb4 100644 --- a/docs/widgets/services/prowlarr.md +++ b/docs/widgets/services/prowlarr.md @@ -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"]`. diff --git a/docs/widgets/services/proxmox.md b/docs/widgets/services/proxmox.md index 3a42e4454bc..c6777fe573e 100644 --- a/docs/widgets/services/proxmox.md +++ b/docs/widgets/services/proxmox.md @@ -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. diff --git a/docs/widgets/services/proxmoxbackupserver.md b/docs/widgets/services/proxmoxbackupserver.md index 912e7440328..e2700c9baa1 100644 --- a/docs/widgets/services/proxmoxbackupserver.md +++ b/docs/widgets/services/proxmoxbackupserver.md @@ -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 diff --git a/docs/widgets/services/pterodactyl.md b/docs/widgets/services/pterodactyl.md index 90084253f9a..1a0d139b095 100644 --- a/docs/widgets/services/pterodactyl.md +++ b/docs/widgets/services/pterodactyl.md @@ -3,6 +3,8 @@ title: Pterodactyl description: Pterodactyl Widget Configuration --- +[Pterodactyl](https://github.com/pterodactyl) + Allowed fields: `["nodes", "servers"]` ```yaml diff --git a/docs/widgets/services/pyload.md b/docs/widgets/services/pyload.md index b35c639aa13..f24bc413fac 100644 --- a/docs/widgets/services/pyload.md +++ b/docs/widgets/services/pyload.md @@ -3,6 +3,8 @@ title: Pyload description: Pyload Widget Configuration --- +[Pyload](https://github.com/pyload/pyload) + Allowed fields: `["speed", "active", "queue", "total"]`. ```yaml diff --git a/docs/widgets/services/qbittorrent.md b/docs/widgets/services/qbittorrent.md index 28b9ee5fc8c..e062adf99f3 100644 --- a/docs/widgets/services/qbittorrent.md +++ b/docs/widgets/services/qbittorrent.md @@ -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"]`. diff --git a/docs/widgets/services/qnap.md b/docs/widgets/services/qnap.md index 6cb950f9783..54067bbce04 100644 --- a/docs/widgets/services/qnap.md +++ b/docs/widgets/services/qnap.md @@ -3,6 +3,8 @@ title: QNAP description: QNAP Widget Configuration --- +[QNAP](https://www.qnap.com) + Allowed fields: `["cpuUsage", "memUsage", "systemTempC", "poolUsage", "volumeUsage"]`. ```yaml diff --git a/docs/widgets/services/radarr.md b/docs/widgets/services/radarr.md index 7782c2aec2f..62cc40fdcff 100644 --- a/docs/widgets/services/radarr.md +++ b/docs/widgets/services/radarr.md @@ -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"]`. diff --git a/docs/widgets/services/readarr.md b/docs/widgets/services/readarr.md index c8c314d1f84..3813dc2b37b 100644 --- a/docs/widgets/services/readarr.md +++ b/docs/widgets/services/readarr.md @@ -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"]`. diff --git a/docs/widgets/services/rutorrent.md b/docs/widgets/services/rutorrent.md index 33b54293744..027fa09ca71 100644 --- a/docs/widgets/services/rutorrent.md +++ b/docs/widgets/services/rutorrent.md @@ -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"]`. diff --git a/docs/widgets/services/sabnzbd.md b/docs/widgets/services/sabnzbd.md index d78ee22e10c..203af003a6b 100644 --- a/docs/widgets/services/sabnzbd.md +++ b/docs/widgets/services/sabnzbd.md @@ -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"]`. diff --git a/docs/widgets/services/scrutiny.md b/docs/widgets/services/scrutiny.md index bcdfd2dd6ec..917c3043506 100644 --- a/docs/widgets/services/scrutiny.md +++ b/docs/widgets/services/scrutiny.md @@ -3,6 +3,8 @@ title: Scrutiny description: Scrutiny Widget Configuration --- +[Scrutiny](https://github.com/AnalogJ/scrutiny) + Allowed fields: `["passed", "failed", "unknown"]`. ```yaml diff --git a/docs/widgets/services/sonarr.md b/docs/widgets/services/sonarr.md index 0f4102bf186..3383ec9e3df 100644 --- a/docs/widgets/services/sonarr.md +++ b/docs/widgets/services/sonarr.md @@ -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"]`. diff --git a/docs/widgets/services/speedtest-tracker.md b/docs/widgets/services/speedtest-tracker.md index 35eeabc5cbe..f819405edd0 100644 --- a/docs/widgets/services/speedtest-tracker.md +++ b/docs/widgets/services/speedtest-tracker.md @@ -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). diff --git a/docs/widgets/services/syncthing-relay-server.md b/docs/widgets/services/syncthing-relay-server.md index 89017cd13a5..1b607d79192 100644 --- a/docs/widgets/services/syncthing-relay-server.md +++ b/docs/widgets/services/syncthing-relay-server.md @@ -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"]`. diff --git a/docs/widgets/services/tailscale.md b/docs/widgets/services/tailscale.md index 8f3f0d56869..ee17d8b1285 100644 --- a/docs/widgets/services/tailscale.md +++ b/docs/widgets/services/tailscale.md @@ -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`. diff --git a/docs/widgets/services/tdarr.md b/docs/widgets/services/tdarr.md index e54c1abb24e..33e527557bc 100644 --- a/docs/widgets/services/tdarr.md +++ b/docs/widgets/services/tdarr.md @@ -3,6 +3,8 @@ title: Tdarr description: Tdarr Widget Configuration --- +[Tdarr](https://github.com/HaveAGitGat/Tdarr) + Allowed fields: `["queue", "processed", "errored", "saved"]`. ```yaml diff --git a/docs/widgets/services/traefik.md b/docs/widgets/services/traefik.md index a1c3e5b16e4..cfe7a381372 100644 --- a/docs/widgets/services/traefik.md +++ b/docs/widgets/services/traefik.md @@ -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. diff --git a/docs/widgets/services/transmission.md b/docs/widgets/services/transmission.md index ad09b57ed5d..3edf2d14fba 100644 --- a/docs/widgets/services/transmission.md +++ b/docs/widgets/services/transmission.md @@ -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"]`. diff --git a/docs/widgets/services/truenas.md b/docs/widgets/services/truenas.md index 8dc58d08efd..718f41f824f 100644 --- a/docs/widgets/services/truenas.md +++ b/docs/widgets/services/truenas.md @@ -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/). diff --git a/docs/widgets/services/tubearchivist.md b/docs/widgets/services/tubearchivist.md index f1628c8c753..c7ffc02d057 100644 --- a/docs/widgets/services/tubearchivist.md +++ b/docs/widgets/services/tubearchivist.md @@ -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"]`. diff --git a/docs/widgets/services/unifi-controller.md b/docs/widgets/services/unifi-controller.md index 62c72aa66c2..ce746808cf5 100644 --- a/docs/widgets/services/unifi-controller.md +++ b/docs/widgets/services/unifi-controller.md @@ -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. diff --git a/docs/widgets/services/unmanic.md b/docs/widgets/services/unmanic.md index a52da87a610..9c16c4acfd0 100644 --- a/docs/widgets/services/unmanic.md +++ b/docs/widgets/services/unmanic.md @@ -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 diff --git a/docs/widgets/services/uptime-kuma.md b/docs/widgets/services/uptime-kuma.md index 6aa806f17d9..8c464badcc0 100644 --- a/docs/widgets/services/uptime-kuma.md +++ b/docs/widgets/services/uptime-kuma.md @@ -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"]`. diff --git a/docs/widgets/services/uptimerobot.md b/docs/widgets/services/uptimerobot.md index 5554bb73796..7f9e8b87856 100644 --- a/docs/widgets/services/uptimerobot.md +++ b/docs/widgets/services/uptimerobot.md @@ -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 diff --git a/docs/widgets/services/urbackup.md b/docs/widgets/services/urbackup.md index 1af189d20f7..86ef4133bf2 100644 --- a/docs/widgets/services/urbackup.md +++ b/docs/widgets/services/urbackup.md @@ -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. diff --git a/docs/widgets/services/watchtower.md b/docs/widgets/services/watchtower.md index 47b937d2c86..f1ff7a3b4f1 100644 --- a/docs/widgets/services/watchtower.md +++ b/docs/widgets/services/watchtower.md @@ -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"]`. diff --git a/docs/widgets/services/whatsupdocker.md b/docs/widgets/services/whatsupdocker.md index c9427de5595..5e259217b3d 100644 --- a/docs/widgets/services/whatsupdocker.md +++ b/docs/widgets/services/whatsupdocker.md @@ -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"]`. diff --git a/docs/widgets/services/xteve.md b/docs/widgets/services/xteve.md index fbb4f313a8b..6fe6c547643 100644 --- a/docs/widgets/services/xteve.md +++ b/docs/widgets/services/xteve.md @@ -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