-
{r.name}
+ {r.type !== "searchSuggestion" &&
{r.name}}
+ {r.type === "searchSuggestion" && (
+
+
+ {r.name.indexOf(searchString) === 0 ? searchString : ""}
+
+
+ {r.name.indexOf(searchString) === 0 ? r.name.substring(searchString.length) : r.name}
+
+
+ )}
{r.description && (
{searchDescriptions && r.priority < 2 ? highlightText(r.description) : r.description}
diff --git a/src/components/widgets/search/search.jsx b/src/components/widgets/search/search.jsx
index 0e439132..6a634308 100644
--- a/src/components/widgets/search/search.jsx
+++ b/src/components/widgets/search/search.jsx
@@ -2,7 +2,7 @@ import { useState, useEffect, useCallback, Fragment } from "react";
import { useTranslation } from "next-i18next";
import { FiSearch } from "react-icons/fi";
import { SiDuckduckgo, SiMicrosoftbing, SiGoogle, SiBaidu, SiBrave } from "react-icons/si";
-import { Listbox, Transition } from "@headlessui/react";
+import { Listbox, Transition, Combobox } from "@headlessui/react";
import classNames from "classnames";
import ContainerForm from "../widget/container_form";
@@ -12,26 +12,31 @@ export const searchProviders = {
google: {
name: "Google",
url: "https://www.google.com/search?q=",
+ suggestionUrl: "https://www.google.com/complete/search?client=chrome&q=",
icon: SiGoogle,
},
duckduckgo: {
name: "DuckDuckGo",
url: "https://duckduckgo.com/?q=",
+ suggestionUrl: "https://duckduckgo.com/ac/?type=list&q=",
icon: SiDuckduckgo,
},
bing: {
name: "Bing",
url: "https://www.bing.com/search?q=",
+ suggestionUrl: "https://api.bing.com/osjson.aspx?query=",
icon: SiMicrosoftbing,
},
baidu: {
name: "Baidu",
url: "https://www.baidu.com/s?wd=",
+ suggestionUrl: "http://suggestion.baidu.com/su?&action=opensearch&ie=utf-8&wd=",
icon: SiBaidu,
},
brave: {
name: "Brave",
url: "https://search.brave.com/search?q=",
+ suggestionUrl: "https://search.brave.com/api/suggest?&rich=false&q=",
icon: SiBrave,
},
custom: {
@@ -72,6 +77,7 @@ export default function Search({ options }) {
const [selectedProvider, setSelectedProvider] = useState(
searchProviders[availableProviderIds[0] ?? searchProviders.google],
);
+ const [searchSuggestions, setSearchSuggestions] = useState([]);
useEffect(() => {
const storedProvider = getStoredProvider();
@@ -82,9 +88,40 @@ export default function Search({ options }) {
}
}, [availableProviderIds]);
+ useEffect(() => {
+ const abortController = new AbortController();
+
+ if (
+ options.showSearchSuggestions &&
+ (selectedProvider.suggestionUrl || options.suggestionUrl) && // custom providers pass url via options
+ query.trim() !== searchSuggestions[0]
+ ) {
+ fetch(`/api/search/searchSuggestion?query=${encodeURIComponent(query)}&providerName=${selectedProvider.name}`, {
+ signal: abortController.signal,
+ })
+ .then(async (searchSuggestionResult) => {
+ const newSearchSuggestions = await searchSuggestionResult.json();
+
+ if (newSearchSuggestions) {
+ if (newSearchSuggestions[1].length > 4) {
+ newSearchSuggestions[1] = newSearchSuggestions[1].splice(0, 4);
+ }
+ setSearchSuggestions(newSearchSuggestions);
+ }
+ })
+ .catch(() => {
+ // If there is an error, just ignore it. There just will be no search suggestions.
+ });
+ }
+
+ return () => {
+ abortController.abort();
+ };
+ }, [selectedProvider, options, query, searchSuggestions]);
+
const submitCallback = useCallback(
- (event) => {
- const q = encodeURIComponent(query);
+ (value) => {
+ const q = encodeURIComponent(value);
const { url } = selectedProvider;
if (url) {
window.open(`${url}${q}`, options.target || "_blank");
@@ -92,11 +129,9 @@ export default function Search({ options }) {
window.open(`${options.url}${q}`, options.target || "_blank");
}
- event.preventDefault();
- event.target.reset();
setQuery("");
},
- [options.target, options.url, query, selectedProvider],
+ [selectedProvider, options.url, options.target],
);
if (!availableProviderIds) {
@@ -109,84 +144,111 @@ export default function Search({ options }) {
};
return (
-
+
-
+
-
setQuery(s.currentTarget.value)}
- required
- autoCapitalize="off"
- autoCorrect="off"
- autoComplete="off"
- // eslint-disable-next-line jsx-a11y/no-autofocus
- autoFocus={options.focus}
- />
-
-
-
-
- {t("search.search")}
-
-
-
+ setQuery(event.target.value)}
+ required
+ autoCapitalize="off"
+ autoCorrect="off"
+ autoComplete="off"
+ // eslint-disable-next-line jsx-a11y/no-autofocus
+ autoFocus={options.focus}
+ />
+
-
+
+
+ {t("search.search")}
+
+
+
-
- {availableProviderIds.map((providerId) => {
- const p = searchProviders[providerId];
- return (
-
- {({ active }) => (
-
-
-
- )}
-
- );
- })}
+
+
+ {availableProviderIds.map((providerId) => {
+ const p = searchProviders[providerId];
+ return (
+
+ {({ active }) => (
+
+
+
+ )}
+
+ );
+ })}
+
+
+
+
+ {searchSuggestions[1]?.length > 0 && (
+
+
+
+ {searchSuggestions[1].map((suggestion) => (
+
+ {({ active }) => (
+
+ {suggestion.indexOf(query) === 0 ? query : ""}
+
+ {suggestion.indexOf(query) === 0 ? suggestion.substring(query.length) : suggestion}
+
+
+ )}
+
+ ))}
+ )}
+
+
+The default [bookmarks.yaml](https://github.com/gethomepage/homepage/blob/main/src/skeleton/bookmarks.yaml) is a working example.
diff --git a/docs/configs/settings.md b/docs/configs/settings.md
index 2ace2c34..d52a88b9 100644
--- a/docs/configs/settings.md
+++ b/docs/configs/settings.md
@@ -359,12 +359,14 @@ There are a few optional settings for the Quick Launch feature:
- `searchDescriptions`: which lets you control whether item descriptions are included in searches. This is off by default. When enabled, results that match the item name will be placed above those that only match the description.
- `hideInternetSearch`: disable automatically including the currently-selected web search (e.g. from the widget) as a Quick Launch option. This is false by default, enabling the feature.
+- `showSearchSuggestions`: shows search suggestions for the internet search. This value will be inherited from the search widget if it is not specified. If it is not specified there either, it will default to false.
- `hideVisitURL`: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.
```yaml
quicklaunch:
searchDescriptions: true
hideInternetSearch: true
+ showSearchSuggestions: true
hideVisitURL: true
```
diff --git a/docs/more/development.md b/docs/more/development.md
index 83a2f032..b1252112 100644
--- a/docs/more/development.md
+++ b/docs/more/development.md
@@ -41,14 +41,15 @@ See the [pre-commit documentation](https://pre-commit.com/#install) to get start
## New Feature Guidelines
-- New features should be linked to an existing feature request with at least 5 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users.
+- New features should be linked to an existing feature request with at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users.
- If you have ideas for a larger feature, please open a discussion first.
+- Please note that though it is a requirement, a discussion with 10 'up-votes' in no way guarantees that a PR will be merged.
## Service Widget Guidelines
To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:
-- Please only submit widgets that have been requested and have at least 5 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
+- Please only submit widgets that have been requested and have at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
- Widgets should be only one row of blocks
- Widgets should be no more than 4 blocks wide
- Minimize the number of API calls
diff --git a/docs/more/troubleshooting.md b/docs/more/troubleshooting.md
index a718f927..9c60a09f 100644
--- a/docs/more/troubleshooting.md
+++ b/docs/more/troubleshooting.md
@@ -8,7 +8,7 @@ hide:
## Introducing the Homepage AI Bot
-Thanks to the generous folks at [Glime](https://glimelab.ai), Homepage is now equipped with a pretty helpful AI-powered bot. The bot has full knowledge of our docs, GitHub issues and discussions and great at answering specific questions about setting up your Homepage. To use the bot, just hit the 'Ask AI' button on any page in our docs or check out the [#ai-support channel on Discord](https://discord.com/channels/1019316731635834932/1177885603552038993)!
+Thanks to the generous folks at [Glime](https://glimelab.ai), Homepage is now equipped with a pretty clever AI-powered bot. The bot has full knowledge of our docs, GitHub issues and discussions and is great at answering specific questions about setting up your Homepage. To use the bot, just hit the 'Ask AI' button on any page in our docs, [open a GitHub discussion](https://github.com/gethomepage/homepage/discussions) or check out the [#ai-support channel on Discord](https://discord.com/channels/1019316731635834932/1177885603552038993)!
## General Troubleshooting Tips
diff --git a/docs/widgets/info/search.md b/docs/widgets/info/search.md
index a9851bb1..faae6c37 100644
--- a/docs/widgets/info/search.md
+++ b/docs/widgets/info/search.md
@@ -9,6 +9,7 @@ You can add a search bar to your top widget area that can search using Google, D
- search:
provider: google # google, duckduckgo, bing, baidu, brave or custom
focus: true # Optional, will set focus to the search bar on page load
+ showSearchSuggestions: true # Optional, will show search suggestions. Defaults to false
target: _blank # One of _self, _blank, _parent or _top
```
@@ -17,8 +18,10 @@ or for a custom search:
```yaml
- search:
provider: custom
- url: https://lougle.com/?q=
+ url: https://www.ecosia.org/search?q=
target: _blank
+ suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q= # Optional
+ showSearchSuggestions: true # Optional
```
multiple providers is also supported via a dropdown (excluding custom):
@@ -28,4 +31,25 @@ multiple providers is also supported via a dropdown (excluding custom):
provider: [brave, google, duckduckgo]
```
+The response body for the URL provided with the `suggestionUrl` option should look like this:
+
+```json
+[
+ "home",
+ [
+ "home depot",
+ "home depot near me",
+ "home equity loan",
+ "homeworkify",
+ "homedepot.com",
+ "homebase login",
+ "home depot credit card",
+ "home goods"
+ ]
+]
+```
+
+The first entry of the array contains the search query, the second one is an array of the suggestions.
+In the example above, the search query was **home**.
+
_Added in v0.1.6, updated in 0.6.0_
diff --git a/docs/widgets/services/adguard-home.md b/docs/widgets/services/adguard-home.md
index af922f77..a56d0dd9 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
---
+Learn more about [Adguard Home](https://github.com/AdguardTeam/AdGuardHome).
+
The username and password are the same as used to login to the web interface.
Allowed fields: `["queries", "blocked", "filtered", "latency"]`.
diff --git a/docs/widgets/services/atsumeru.md b/docs/widgets/services/atsumeru.md
index 77432216..ab110c63 100644
--- a/docs/widgets/services/atsumeru.md
+++ b/docs/widgets/services/atsumeru.md
@@ -3,6 +3,8 @@ title: Atsumeru
description: Atsumeru Widget Configuration
---
+Learn more about [Atsumeru](https://github.com/AtsumeruDev/Atsumeru).
+
Define same username and password that is used for login from web or supported apps
Allowed fields: `["series", "archives", "chapters", "categories"]`.
diff --git a/docs/widgets/services/audiobookshelf.md b/docs/widgets/services/audiobookshelf.md
index 10beec24..96a4efce 100644
--- a/docs/widgets/services/audiobookshelf.md
+++ b/docs/widgets/services/audiobookshelf.md
@@ -3,6 +3,8 @@ title: Audiobookshelf
description: Audiobookshelf Widget Configuration
---
+Learn more about [Audiobookshelf](https://github.com/advplyr/audiobookshelf).
+
You can find your API token by logging into the Audiobookshelf web app as an admin, go to the config → users page, and click on your account.
Allowed fields: `["podcasts", "podcastsDuration", "books", "booksDuration"]`
diff --git a/docs/widgets/services/authentik.md b/docs/widgets/services/authentik.md
index b3f8cdd6..3b84009f 100644
--- a/docs/widgets/services/authentik.md
+++ b/docs/widgets/services/authentik.md
@@ -3,6 +3,8 @@ title: Authentik
description: Authentik Widget Configuration
---
+Learn more about [Authentik](https://github.com/goauthentik/authentik).
+
This widget reads the number of active users in the system, as well as logins for the last 24 hours.
You will need to generate an API token for an existing user. To do so follow these steps:
diff --git a/docs/widgets/services/autobrr.md b/docs/widgets/services/autobrr.md
index d41d7c32..4828f385 100644
--- a/docs/widgets/services/autobrr.md
+++ b/docs/widgets/services/autobrr.md
@@ -3,6 +3,8 @@ title: Autobrr
description: Autobrr Widget Configuration
---
+Learn more about [Autobrr](https://github.com/autobrr/autobrr).
+
Find your API key under `Settings > API Keys`.
Allowed fields: `["approvedPushes", "rejectedPushes", "filters", "indexers"]`.
diff --git a/docs/widgets/services/azuredevops.md b/docs/widgets/services/azuredevops.md
index 86ad7418..218007fe 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
---
+Learn more about [Azure DevOps](https://azure.microsoft.com/en-us/products/devops).
+
This widget has 2 functions:
1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.\
diff --git a/docs/widgets/services/bazarr.md b/docs/widgets/services/bazarr.md
index ac1a95c8..86f75800 100644
--- a/docs/widgets/services/bazarr.md
+++ b/docs/widgets/services/bazarr.md
@@ -3,6 +3,8 @@ title: Bazarr
description: Bazarr Widget Configuration
---
+Learn more about [Bazarr](https://github.com/morpheus65535/bazarr).
+
Find your API key under `Settings > General`.
Allowed fields: `["missingEpisodes", "missingMovies"]`.
diff --git a/docs/widgets/services/caddy.md b/docs/widgets/services/caddy.md
index c85d1d9a..8c088f63 100644
--- a/docs/widgets/services/caddy.md
+++ b/docs/widgets/services/caddy.md
@@ -3,6 +3,8 @@ title: Caddy
description: Caddy Widget Configuration
---
+Learn more about [Caddy](https://github.com/caddyserver/caddy).
+
Allowed fields: `["upstreams", "requests", "requests_failed"]`.
```yaml
diff --git a/docs/widgets/services/calibre-web.md b/docs/widgets/services/calibre-web.md
index 454e3105..cbf99675 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
---
+Learn more about [Calibre-web](https://github.com/janeczku/calibre-web).
+
**Note: widget requires calibre-web ≥ v0.6.21.**
Allowed fields: `["books", "authors", "categories", "series"]`.
diff --git a/docs/widgets/services/changedetectionio.md b/docs/widgets/services/changedetectionio.md
index 060043fd..9baee6cb 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
---
+Learn more about [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 59edaac5..bedf8037 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
---
+Learn more about [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 663d0d6e..385fd59c 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
---
+Learn more about [Cloudflare Tunnels](https://www.cloudflare.com/products/tunnel/).
+
_As of v0.6.10 this widget no longer accepts a Cloudflare global API key (or account email) due to security concerns. Instead, you should setup an API token which only requires the permissions `Account.Cloudflare Tunnel:Read`._
Allowed fields: `["status", "origin_ip"]`.
diff --git a/docs/widgets/services/coin-market-cap.md b/docs/widgets/services/coin-market-cap.md
index 558482a1..d57c512c 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
---
+Learn more about [Coin Market Cap](https://coinmarketcap.com/api).
+
Get your API key from your [CoinMarketCap Pro Dashboard](https://pro.coinmarketcap.com/account).
Allowed fields: no configurable fields for this widget.
@@ -16,7 +18,7 @@ widget:
defaultinterval: 7d # Optional
```
-You can also specify slugs instead of symbols (since symbols aren't garaunteed to be unique). If you supply both, slugs will be used. For example:
+You can also specify slugs instead of symbols (since symbols aren't guaranteed to be unique). If you supply both, slugs will be used. For example:
```yaml
widget:
diff --git a/docs/widgets/services/deluge.md b/docs/widgets/services/deluge.md
index 9408ea2a..817ae831 100644
--- a/docs/widgets/services/deluge.md
+++ b/docs/widgets/services/deluge.md
@@ -3,6 +3,8 @@ title: Deluge
description: Deluge Widget Configuration
---
+Learn more about [Deluge](https://deluge-torrent.org/).
+
Uses the same password used to login to the webui, see [the deluge FAQ](https://dev.deluge-torrent.org/wiki/Faq#Whatisthedefaultpassword).
Allowed fields: `["leech", "download", "seed", "upload"]`.
diff --git a/docs/widgets/services/diskstation.md b/docs/widgets/services/diskstation.md
index 29936d30..36010bfa 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
---
+Learn more about [Synology Disk Station](https://www.synology.com/en-global/dsm).
+
Note: the widget is not compatible with 2FA.
An optional 'volume' parameter can be supplied to specify which volume's free space to display when more than one volume exists. The value of the parameter must be in form of `volume_N`, e.g. to display free space for volume2, `volume_2` should be set as 'volume' value. If omitted, first returned volume's free space will be shown (not guaranteed to be volume1).
diff --git a/docs/widgets/services/downloadstation.md b/docs/widgets/services/downloadstation.md
index 22bb8da9..5a6d3b2f 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
---
+Learn more about [Synology Download Station](https://www.synology.com/en-us/dsm/packages/DownloadStation).
+
Note: the widget is not compatible with 2FA.
Allowed fields: `["leech", "download", "seed", "upload"]`.
diff --git a/docs/widgets/services/emby.md b/docs/widgets/services/emby.md
index fb922d76..f262bfc6 100644
--- a/docs/widgets/services/emby.md
+++ b/docs/widgets/services/emby.md
@@ -3,6 +3,8 @@ title: Emby
description: Emby Widget Configuration
---
+Learn more about [Emby](https://github.com/MediaBrowser/Emby).
+
You can create an API key from inside Emby at `Settings > Advanced > Api Keys`.
As of v0.6.11 the widget supports fields `["movies", "series", "episodes", "songs"]`. These blocks are disabled by default but can be enabled with the `enableBlocks` option, and the "Now Playing" feature (enabled by default) can be disabled with the `enableNowPlaying` option.
diff --git a/docs/widgets/services/evcc.md b/docs/widgets/services/evcc.md
index a3b95ba7..108b6eb4 100644
--- a/docs/widgets/services/evcc.md
+++ b/docs/widgets/services/evcc.md
@@ -3,6 +3,8 @@ title: EVCC
description: EVCC Widget Configuration
---
+Learn more about [EVSS](https://github.com/evcc-io/evcc).
+
Allowed fields: `["pv_power", "grid_power", "home_power", "charge_power]`.
```yaml
diff --git a/docs/widgets/services/fileflows.md b/docs/widgets/services/fileflows.md
index 2679cbd7..e05ca527 100644
--- a/docs/widgets/services/fileflows.md
+++ b/docs/widgets/services/fileflows.md
@@ -3,6 +3,8 @@ title: Fileflows
description: Fileflows Widget Configuration
---
+Learn more about [FileFlows](https://github.com/revenz/FileFlows).
+
Allowed fields: `["queue", "processing", "processed", "time"]`.
```yaml
diff --git a/docs/widgets/services/flood.md b/docs/widgets/services/flood.md
index 8585fedb..3aaeb49c 100644
--- a/docs/widgets/services/flood.md
+++ b/docs/widgets/services/flood.md
@@ -3,6 +3,8 @@ title: Flood
description: Flood Widget Configuration
---
+Learn more about [Flood](https://github.com/jesec/flood).
+
Allowed fields: `["leech", "download", "seed", "upload"]`.
```yaml
diff --git a/docs/widgets/services/freshrss.md b/docs/widgets/services/freshrss.md
index d9e8834f..bc09e6a9 100644
--- a/docs/widgets/services/freshrss.md
+++ b/docs/widgets/services/freshrss.md
@@ -3,6 +3,8 @@ title: FreshRSS
description: FreshRSS Widget Configuration
---
+Learn more about [FreshRSS](https://github.com/FreshRSS/FreshRSS).
+
Please refer to [Enable the API in FreshRSS](https://freshrss.github.io/FreshRSS/en/users/06_Mobile_access.html#enable-the-api-in-freshrss) for the "API password" to be entered in the password field.
Allowed fields: `["subscriptions", "unread"]`.
diff --git a/docs/widgets/services/gamedig.md b/docs/widgets/services/gamedig.md
index d287f69a..6e7eb4d5 100644
--- a/docs/widgets/services/gamedig.md
+++ b/docs/widgets/services/gamedig.md
@@ -3,6 +3,8 @@ title: GameDig
description: GameDig Widget Configuration
---
+Learn more about [GameDig](https://github.com/gamedig/node-gamedig).
+
Uses the [GameDig](https://www.npmjs.com/package/gamedig) library to get game server information for any supported server type.
Allowed fields (limited to a max of 4): `["status", "name", "map", "currentPlayers", "players", "maxPlayers", "bots", "ping"]`.
diff --git a/docs/widgets/services/gatus.md b/docs/widgets/services/gatus.md
new file mode 100644
index 00000000..3918b9f3
--- /dev/null
+++ b/docs/widgets/services/gatus.md
@@ -0,0 +1,12 @@
+---
+title: Gatus
+description: Gatus Widget Configuration
+---
+
+Allowed fields: `["up", "down", "uptime"]`.
+
+```yaml
+widget:
+ type: gatus
+ url: http://gatus.host.or.ip:port
+```
diff --git a/docs/widgets/services/ghostfolio.md b/docs/widgets/services/ghostfolio.md
index 554e6843..42e03bb5 100644
--- a/docs/widgets/services/ghostfolio.md
+++ b/docs/widgets/services/ghostfolio.md
@@ -3,6 +3,8 @@ title: Ghostfolio
description: Ghostfolio Widget Configuration
---
+Learn more about [Ghostfolio](https://github.com/ghostfolio/ghostfolio).
+
Authentication requires manually obtaining a Bearer token which can be obtained by make a POST request to the API e.g.
```
diff --git a/docs/widgets/services/glances.md b/docs/widgets/services/glances.md
index abd756a9..d8f9e9ca 100644
--- a/docs/widgets/services/glances.md
+++ b/docs/widgets/services/glances.md
@@ -3,6 +3,8 @@ title: Glances
description: Glances Widget Configuration
---
+Learn more about [Glances](https://github.com/nicolargo/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 362be0c3..7f1f6921 100644
--- a/docs/widgets/services/gluetun.md
+++ b/docs/widgets/services/gluetun.md
@@ -3,6 +3,8 @@ title: Gluetun
description: Gluetun Widget Configuration
---
+Learn more about [Gluetun](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 871eefaa..785b55a4 100644
--- a/docs/widgets/services/gotify.md
+++ b/docs/widgets/services/gotify.md
@@ -3,6 +3,8 @@ title: Gotify
description: Gotify Widget Configuration
---
+Learn more about [Gotify](https://github.com/gotify/server).
+
Get a Gotify client token from an existing client or create a new one on your Gotify admin page.
Allowed fields: `["apps", "clients", "messages"]`.
diff --git a/docs/widgets/services/grafana.md b/docs/widgets/services/grafana.md
index bfdebb2c..272cc3ba 100644
--- a/docs/widgets/services/grafana.md
+++ b/docs/widgets/services/grafana.md
@@ -3,6 +3,8 @@ title: Grafana
description: Grafana Widget Configuration
---
+Learn more about [Grafana](https://github.com/grafana/grafana).
+
Allowed fields: `["dashboards", "datasources", "totalalerts", "alertstriggered"]`.
```yaml
diff --git a/docs/widgets/services/hdhomerun.md b/docs/widgets/services/hdhomerun.md
index c862200e..261ab046 100644
--- a/docs/widgets/services/hdhomerun.md
+++ b/docs/widgets/services/hdhomerun.md
@@ -3,10 +3,16 @@ title: HDHomerun
description: HDHomerun Widget Configuration
---
-Allowed fields: `["channels", "hd"]`.
+Learn more about [HDHomerun](https://www.silicondust.com/support/downloads/).
+
+Allowed fields: `["channels", "hd", "tunerCount", "channelNumber", "channelNetwork", "signalStrength", "signalQuality", "symbolQuality", "networkRate", "clientIP" ]`.
+
+If more than 4 fields are provided, only the first 4 are displayed.
```yaml
widget:
type: hdhomerun
url: http://hdhomerun.host.or.ip
+ tuner: 0 # optional - defaults to 0, used for tuner-specific fields
+ fields: ["channels", "hd"] # optional - default fields shown
```
diff --git a/docs/widgets/services/healthchecks.md b/docs/widgets/services/healthchecks.md
index b438e153..136d9fe6 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
---
+Learn more about [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 8d8b04e9..e4e1e5b4 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
---
+Learn more about [Home Assistant](https://www.home-assistant.io/).
+
You will need to generate a long-lived access token for an existing Home Assistant user in its profile.
Allowed fields: `["people_home", "lights_on", "switches_on"]`.
diff --git a/docs/widgets/services/homebridge.md b/docs/widgets/services/homebridge.md
index d71ca93b..1fb64132 100644
--- a/docs/widgets/services/homebridge.md
+++ b/docs/widgets/services/homebridge.md
@@ -3,6 +3,8 @@ title: Homebridge
description: Homebridge
---
+Learn more about [Homebridge](https://github.com/homebridge/homebridge).
+
The Homebridge API is actually provided by the Config UI X plugin that has been included with Homebridge for a while, still it is required to be installed for this widget to work.
Allowed fields: `["updates", "child_bridges"]`.
diff --git a/docs/widgets/services/immich.md b/docs/widgets/services/immich.md
index 6fd37e51..63780ee0 100644
--- a/docs/widgets/services/immich.md
+++ b/docs/widgets/services/immich.md
@@ -3,6 +3,10 @@ title: Immich
description: Immich Widget Configuration
---
+Learn more about [Immich](https://github.com/immich-app/immich).
+
+Find your API key under `Account Settings > API Keys`.
+
Allowed fields: `["users" ,"photos", "videos", "storage"]`.
Note that API key must be from admin user.
diff --git a/docs/widgets/services/jackett.md b/docs/widgets/services/jackett.md
index 91c58b28..22e089a4 100644
--- a/docs/widgets/services/jackett.md
+++ b/docs/widgets/services/jackett.md
@@ -3,6 +3,8 @@ title: Jackett
description: Jackett Widget Configuration
---
+Learn more about [Jackett](https://github.com/Jackett/Jackett).
+
Jackett must not have any authentication for the widget to work.
Allowed fields: `["configured", "errored"]`.
@@ -11,4 +13,5 @@ Allowed fields: `["configured", "errored"]`.
widget:
type: jackett
url: http://jackett.host.or.ip
+ key: jackettapikey
```
diff --git a/docs/widgets/services/jdownloader.md b/docs/widgets/services/jdownloader.md
index 31469fb9..0b193fc3 100644
--- a/docs/widgets/services/jdownloader.md
+++ b/docs/widgets/services/jdownloader.md
@@ -3,6 +3,8 @@ title: JDownloader
description: NextPVR Widget Configuration
---
+Learn more about [JDownloader](https://jdownloader.org/).
+
Basic widget to show number of items in download queue, along with the queue size and current download speed.
Allowed fields: `["downloadCount", "downloadTotalBytes","downloadBytesRemaining", "downloadSpeed"]`.
diff --git a/docs/widgets/services/jellyfin.md b/docs/widgets/services/jellyfin.md
index cc961789..0428c622 100644
--- a/docs/widgets/services/jellyfin.md
+++ b/docs/widgets/services/jellyfin.md
@@ -3,6 +3,8 @@ title: Jellyfin
description: Jellyfin Widget Configuration
---
+Learn more about [Jellyfin](https://github.com/jellyfin/jellyfin).
+
You can create an API key from inside Jellyfin at `Settings > Advanced > Api Keys`.
As of v0.6.11 the widget supports fields `["movies", "series", "episodes", "songs"]`. These blocks are disabled by default but can be enabled with the `enableBlocks` option, and the "Now Playing" feature (enabled by default) can be disabled with the `enableNowPlaying` option.
diff --git a/docs/widgets/services/jellyseerr.md b/docs/widgets/services/jellyseerr.md
index f6e071d8..ad33ca52 100644
--- a/docs/widgets/services/jellyseerr.md
+++ b/docs/widgets/services/jellyseerr.md
@@ -3,6 +3,8 @@ title: Jellyseerr
description: Jellyseerr Widget Configuration
---
+Learn more about [Jellyseerr](https://github.com/Fallenbagel/jellyseerr).
+
Find your API key under `Settings > General > API Key`.
Allowed fields: `["pending", "approved", "available"]`.
diff --git a/docs/widgets/services/kavita.md b/docs/widgets/services/kavita.md
index 59bc91d4..12d40164 100644
--- a/docs/widgets/services/kavita.md
+++ b/docs/widgets/services/kavita.md
@@ -3,7 +3,9 @@ title: Kavita
description: Kavita Widget Configuration
---
-Uses the same username and password used to login from the web.
+Learn more about [Kavita](https://github.com/Kareadita/Kavita).
+
+Uses the same admin role 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 a05f67d9..c9edaeb2 100644
--- a/docs/widgets/services/komga.md
+++ b/docs/widgets/services/komga.md
@@ -3,6 +3,8 @@ title: Komga
description: Komga Widget Configuration
---
+Learn more about [Komga](https://github.com/gotson/komga).
+
Uses the same username and password used to login from the web.
Allowed fields: `["libraries", "series", "books"]`.
diff --git a/docs/widgets/services/kopia.md b/docs/widgets/services/kopia.md
index 00f1ff70..bb324b26 100644
--- a/docs/widgets/services/kopia.md
+++ b/docs/widgets/services/kopia.md
@@ -3,6 +3,8 @@ title: Kopia
description: Kopia Widget Configuration
---
+Learn more about [Kopia](https://github.com/kopia/kopia).
+
Allowed fields: `["status", "size", "lastrun", "nextrun"]`.
You may optionally pass values for `snapshotHost` and / or `snapshotPath` to select a specific backup source for the widget.
diff --git a/docs/widgets/services/lidarr.md b/docs/widgets/services/lidarr.md
index b6c1e34b..3a84152a 100644
--- a/docs/widgets/services/lidarr.md
+++ b/docs/widgets/services/lidarr.md
@@ -3,6 +3,8 @@ title: Lidarr
description: Lidarr Widget Configuration
---
+Learn more about [Lidarr](https://github.com/Lidarr/Lidarr).
+
Find your API key under `Settings > General`.
Allowed fields: `["wanted", "queued", "artists"]`.
diff --git a/docs/widgets/services/mastodon.md b/docs/widgets/services/mastodon.md
index 5a0ed703..891115da 100644
--- a/docs/widgets/services/mastodon.md
+++ b/docs/widgets/services/mastodon.md
@@ -3,6 +3,8 @@ title: Mastodon
description: Mastodon Widget Configuration
---
+Learn more about [Mastodon](https://github.com/mastodon/mastodon).
+
Use the base URL of the Mastodon instance you'd like to pull stats for. Does not require authentication as the stats are part of the public API endpoints.
Allowed fields: `["user_count", "status_count", "domain_count"]`.
diff --git a/docs/widgets/services/mealie.md b/docs/widgets/services/mealie.md
index cb7b957f..b1cf117b 100644
--- a/docs/widgets/services/mealie.md
+++ b/docs/widgets/services/mealie.md
@@ -3,6 +3,8 @@ title: Mealie
description: Mealie Widget Configuration
---
+Learn more about [Mealie](https://github.com/mealie-recipes/mealie).
+
Generate a user API key under `Profile > Manage Your API Tokens > Generate`.
Allowed fields: `["recipes", "users", "categories", "tags"]`.
diff --git a/docs/widgets/services/medusa.md b/docs/widgets/services/medusa.md
index d9b37fed..e500d95f 100644
--- a/docs/widgets/services/medusa.md
+++ b/docs/widgets/services/medusa.md
@@ -3,6 +3,8 @@ title: Medusa
description: Medusa Widget Configuration
---
+Learn more about [Medusa](https://github.com/medusajs/medusa).
+
Allowed fields: `["wanted", "queued", "series"]`.
```yaml
diff --git a/docs/widgets/services/miniflux.md b/docs/widgets/services/miniflux.md
index 0b1dfc87..3f2e29e0 100644
--- a/docs/widgets/services/miniflux.md
+++ b/docs/widgets/services/miniflux.md
@@ -3,6 +3,8 @@ title: Miniflux
description: Miniflux Widget Configuration
---
+Learn more about [Miniflux](https://github.com/miniflux/v2).
+
Api key is found under Settings > API keys
Allowed fields: `["unread", "read"]`.
diff --git a/docs/widgets/services/moonraker.md b/docs/widgets/services/moonraker.md
index e3374e60..6de62ec6 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
---
+Learn more about [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 9ec1397f..f15e7b9b 100644
--- a/docs/widgets/services/mylar.md
+++ b/docs/widgets/services/mylar.md
@@ -3,6 +3,8 @@ title: Mylar3
description: Mylar3 Widget Configuration
---
+Learn more about [Mylar3](https://github.com/mylar3/mylar3).
+
API must be enabled in Mylar3 settings.
Allowed fields: `["series", "issues", "wanted"]`.
diff --git a/docs/widgets/services/navidrome.md b/docs/widgets/services/navidrome.md
index bb57f635..9fd43a0f 100644
--- a/docs/widgets/services/navidrome.md
+++ b/docs/widgets/services/navidrome.md
@@ -3,6 +3,8 @@ title: Navidrome
description: Navidrome Widget Configuration
---
+Learn more about [Navidrome](https://github.com/navidrome/navidrome).
+
For detailed information about how to generate the token see http://www.subsonic.org/pages/api.jsp.
Allowed fields: no configurable fields for this widget.
diff --git a/docs/widgets/services/netdata.md b/docs/widgets/services/netdata.md
index 70acf490..32b4d677 100644
--- a/docs/widgets/services/netdata.md
+++ b/docs/widgets/services/netdata.md
@@ -3,10 +3,12 @@ title: Netdata
description: Netdata Widget Configuration
---
+Learn more about [Netdata](https://github.com/netdata/netdata).
+
Allowed fields: `["warnings", "criticals"]`.
```yaml
widget:
- type: Netdata
+ type: netdata
url: http://netdata.host.or.ip
```
diff --git a/docs/widgets/services/nextcloud.md b/docs/widgets/services/nextcloud.md
index 1e9d53f9..199098b6 100644
--- a/docs/widgets/services/nextcloud.md
+++ b/docs/widgets/services/nextcloud.md
@@ -3,6 +3,8 @@ title: Nextcloud
description: Nextcloud Widget Configuration
---
+Learn more about [Nextcloud](https://github.com/nextcloud).
+
Use username & password, or the `NC-Token` key. Information about the token can be found under **Settings** > **System**. If both are provided, NC-Token will be used.
Allowed fields: `["cpuload", "memoryusage", "freespace", "activeusers", "numfiles", "numshares"]`.
diff --git a/docs/widgets/services/nextdns.md b/docs/widgets/services/nextdns.md
index b646c11d..4fb5a88b 100644
--- a/docs/widgets/services/nextdns.md
+++ b/docs/widgets/services/nextdns.md
@@ -3,6 +3,8 @@ title: NextDNS
description: NextDNS Widget Configuration
---
+Learn more about [NextDNS](https://nextdns.io/).
+
Api key is found under Account > API, profile ID is found under Setup > Endpoints > ID
```yaml
diff --git a/docs/widgets/services/nginx-proxy-manager.md b/docs/widgets/services/nginx-proxy-manager.md
index dc201627..3b80f8f3 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
---
+Learn more about [Nginx Proxy Manager](https://nginxproxymanager.com/).
+
Login with the same admin username and password used to access the web UI.
Allowed fields: `["enabled", "disabled", "total"]`.
diff --git a/docs/widgets/services/nzbget.md b/docs/widgets/services/nzbget.md
index f069910a..2d7758c9 100644
--- a/docs/widgets/services/nzbget.md
+++ b/docs/widgets/services/nzbget.md
@@ -3,6 +3,8 @@ title: NZBget
description: NZBget Widget Configuration
---
+Learn more about [NZBget](https://github.com/nzbget/nzbget).
+
This widget uses the same authentication method as your browser when logging in (HTTP Basic Auth), and is often referred to as the ControlUsername and ControlPassword inside of Nzbget documentation.
Allowed fields: `["rate", "remaining", "downloaded"]`.
diff --git a/docs/widgets/services/octoprint.md b/docs/widgets/services/octoprint.md
index 7688e13f..c6ddeb07 100644
--- a/docs/widgets/services/octoprint.md
+++ b/docs/widgets/services/octoprint.md
@@ -3,6 +3,8 @@ title: OctoPrint
description: OctoPrintWidget Configuration
---
+Learn more about [OctoPrint](https://octoprint.org/).
+
Allowed fields: `["printer_state", "temp_tool", "temp_bed", "job_completion"]`.
```yaml
diff --git a/docs/widgets/services/ombi.md b/docs/widgets/services/ombi.md
index de2708d0..ab290244 100644
--- a/docs/widgets/services/ombi.md
+++ b/docs/widgets/services/ombi.md
@@ -3,6 +3,8 @@ title: Ombi
description: Ombi Widget Configuration
---
+Learn more about [Ombi](https://github.com/Ombi-app/Ombi).
+
Find your API key under `Settings > Configuration > General`.
Allowed fields: `["pending", "approved", "available"]`.
diff --git a/docs/widgets/services/opendtu.md b/docs/widgets/services/opendtu.md
index 6a6111cc..9a68a8c3 100644
--- a/docs/widgets/services/opendtu.md
+++ b/docs/widgets/services/opendtu.md
@@ -3,6 +3,8 @@ title: OpenDTU
description: OpenDTU Widget
---
+Learn more about [OpenDTU](https://github.com/tbnobody/OpenDTU).
+
Allowed fields: `["yieldDay", "relativePower", "absolutePower", "limit"]`.
```yaml
diff --git a/docs/widgets/services/openmediavault.md b/docs/widgets/services/openmediavault.md
index 43ff2dea..a8a26e1f 100644
--- a/docs/widgets/services/openmediavault.md
+++ b/docs/widgets/services/openmediavault.md
@@ -3,6 +3,8 @@ title: OpenMediaVault
description: OpenMediaVault Widget Configuration
---
+Learn more about [OpenMediaVault](https://www.openmediavault.org/).
+
Provides useful information from your OpenMediaVault
```yaml
diff --git a/docs/widgets/services/openwrt.md b/docs/widgets/services/openwrt.md
new file mode 100644
index 00000000..c1c3ee94
--- /dev/null
+++ b/docs/widgets/services/openwrt.md
@@ -0,0 +1,54 @@
+---
+title: OpenWRT
+description: OpenWRT widget configuration
+---
+
+Learn more about [OpenWRT](https://openwrt.org/).
+
+Provides information from OpenWRT
+
+```yaml
+widget:
+ type: openwrt
+ url: http://host.or.ip
+ username: homepage
+ password: pass
+ interfaceName: eth0 # optional
+```
+
+## Interface
+
+Setting `interfaceName` (e.g. eth0) will display information for that particular device, otherwise the widget will display general system info.
+
+## Authorization
+
+In order for homepage to access the OpenWRT RPC endpoints you will need to [create an ACL](https://openwrt.org/docs/techref/ubus#acls) and [new user](https://openwrt.org/docs/techref/ubus#authentication) in OpenWRT.
+
+Create an ACL named `homepage.json` in `/usr/share/rpcd/acl.d/`, the following permissions will suffice:
+
+```
+{
+ "homepage": {
+ "description": "Homepage widget",
+ "read": {
+ "ubus": {
+ "network.interface.wan": ["status"],
+ "network.interface.lan": ["status"],
+ "network.device": ["status"]
+ "system": ["info"]
+ }
+ },
+ }
+}
+```
+
+Then add a user that will use that ACL in `/etc/config/rpc`:
+
+```config login
+ option username 'homepage'
+ option password '