Documentation: add project links to service widget docs (#2737)

gethomepage · Jan 22, 2024 · 5d550b8 · 5d550b8
1 parent e803c3b
commit 5d550b8
Show file tree

Hide file tree

Showing 97 changed files with 195 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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))_

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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"]`.
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,8 @@ title: Caddy @@
     description: Caddy Widget Configuration
     ---
+    [Caddy](https://github.com/caddyserver/caddy)
     Allowed fields: `["upstreams", "requests", "requests_failed"]`.
     ```yaml
@@ Expand Down @@