@@ -63,7 +69,7 @@ export default function Component({ service }) {
{item.cpu_percent.toFixed(1)}%
{t("common.bytes", {
- value: item.memory_info[memoryInfoKey],
+ value: item.memory_info[memoryInfoKey] ?? item.memory_info.wset,
maximumFractionDigits: 0,
})}
diff --git a/src/widgets/glances/widget.js b/src/widgets/glances/widget.js
index 00d3ac5ad..38da4fd79 100644
--- a/src/widgets/glances/widget.js
+++ b/src/widgets/glances/widget.js
@@ -3,7 +3,7 @@ import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
const widget = {
api: "{url}/api/{endpoint}",
proxyHandler: credentialedProxyHandler,
- allowedEndpoints: /\d\/quicklook|diskio|cpu|fs|gpu|system|mem|network|processlist|sensors/,
+ allowedEndpoints: /\d\/quicklook|diskio|cpu|fs|gpu|system|mem|network|processlist|sensors|containers/,
};
export default widget;
diff --git a/src/widgets/gluetun/widget.js b/src/widgets/gluetun/widget.js
index 91c7d1ed5..2733cec65 100644
--- a/src/widgets/gluetun/widget.js
+++ b/src/widgets/gluetun/widget.js
@@ -7,7 +7,7 @@ const widget = {
mappings: {
ip: {
endpoint: "publicip/ip",
- validate: ["public_ip", "region", "country"],
+ validate: ["public_ip", "country"],
},
},
};
diff --git a/src/widgets/homeassistant/proxy.js b/src/widgets/homeassistant/proxy.js
index fe488f86b..e1f02ddbb 100644
--- a/src/widgets/homeassistant/proxy.js
+++ b/src/widgets/homeassistant/proxy.js
@@ -62,14 +62,14 @@ async function getQuery(query, { url, key }) {
}
export default async function homeassistantProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
diff --git a/src/widgets/homebox/proxy.js b/src/widgets/homebox/proxy.js
index 0d6fdf13c..c91ce5528 100644
--- a/src/widgets/homebox/proxy.js
+++ b/src/widgets/homebox/proxy.js
@@ -68,14 +68,14 @@ async function apiCall(widget, endpoint, service) {
}
export default async function homeboxProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
diff --git a/src/widgets/homebridge/proxy.js b/src/widgets/homebridge/proxy.js
index 17dc8635c..4da9197b0 100644
--- a/src/widgets/homebridge/proxy.js
+++ b/src/widgets/homebridge/proxy.js
@@ -71,14 +71,14 @@ async function apiCall(widget, endpoint, service) {
}
export default async function homebridgeProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/jackett/proxy.js b/src/widgets/jackett/proxy.js
index 5292695fc..035309b36 100644
--- a/src/widgets/jackett/proxy.js
+++ b/src/widgets/jackett/proxy.js
@@ -25,14 +25,14 @@ async function fetchJackettCookie(widget, loginURL) {
}
export default async function jackettProxyHandler(req, res) {
- const { group, service, endpoint } = req.query;
+ const { group, service, endpoint, index } = req.query;
if (!group || !service) {
logger.error("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget || !widgets[widget.type].api) {
logger.error("Invalid or missing widget for service '%s' in group '%s'", service, group);
return res.status(400).json({ error: "Invalid widget configuration" });
diff --git a/src/widgets/jdownloader/proxy.js b/src/widgets/jdownloader/proxy.js
index 88a92d95d..ae8c845ca 100644
--- a/src/widgets/jdownloader/proxy.js
+++ b/src/widgets/jdownloader/proxy.js
@@ -12,12 +12,12 @@ const proxyName = "jdownloaderProxyHandler";
const logger = createLogger(proxyName);
async function getWidget(req) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return null;
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
return null;
diff --git a/src/widgets/kavita/proxy.js b/src/widgets/kavita/proxy.js
index b8e9813f8..1c41c45f1 100644
--- a/src/widgets/kavita/proxy.js
+++ b/src/widgets/kavita/proxy.js
@@ -70,14 +70,14 @@ async function apiCall(widget, endpoint, service) {
}
export default async function KavitaProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
diff --git a/src/widgets/minecraft/proxy.js b/src/widgets/minecraft/proxy.js
index f7bac9d45..98d1be88c 100644
--- a/src/widgets/minecraft/proxy.js
+++ b/src/widgets/minecraft/proxy.js
@@ -7,8 +7,8 @@ const proxyName = "minecraftProxyHandler";
const logger = createLogger(proxyName);
export default async function minecraftProxyHandler(req, res) {
- const { group, service } = req.query;
- const serviceWidget = await getServiceWidget(group, service);
+ const { group, service, index } = req.query;
+ const serviceWidget = await getServiceWidget(group, service, index);
const url = new URL(serviceWidget.url);
try {
const pingResponse = await pingWithPromise(url.hostname, url.port || 25565);
diff --git a/src/widgets/npm/proxy.js b/src/widgets/npm/proxy.js
index 978254f81..6c7ba09ef 100644
--- a/src/widgets/npm/proxy.js
+++ b/src/widgets/npm/proxy.js
@@ -36,10 +36,10 @@ async function login(loginUrl, username, password, service) {
}
export default async function npmProxyHandler(req, res) {
- const { group, service, endpoint } = req.query;
+ const { group, service, endpoint, index } = req.query;
if (group && service) {
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widgets?.[widget.type]?.api) {
return res.status(403).json({ error: "Service does not support API calls" });
diff --git a/src/widgets/omada/proxy.js b/src/widgets/omada/proxy.js
index 8e8994a5b..f4da12936 100644
--- a/src/widgets/omada/proxy.js
+++ b/src/widgets/omada/proxy.js
@@ -33,10 +33,10 @@ async function login(loginUrl, username, password, controllerVersionMajor) {
}
export default async function omadaProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (group && service) {
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (widget) {
const { url } = widget;
diff --git a/src/widgets/openmediavault/proxy.js b/src/widgets/openmediavault/proxy.js
index e1f97a56e..9cda42e86 100644
--- a/src/widgets/openmediavault/proxy.js
+++ b/src/widgets/openmediavault/proxy.js
@@ -12,14 +12,14 @@ const BG_POLL_PERIOD = 500;
const logger = createLogger(PROXY_NAME);
async function getWidget(req) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return null;
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/openwrt/proxy.js b/src/widgets/openwrt/proxy.js
index 977db8ca9..0a0da3ff5 100644
--- a/src/widgets/openwrt/proxy.js
+++ b/src/widgets/openwrt/proxy.js
@@ -17,14 +17,14 @@ const PARAMS = {
};
async function getWidget(req) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return null;
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/photoprism/proxy.js b/src/widgets/photoprism/proxy.js
index 509bfa0c7..fe5096b3a 100644
--- a/src/widgets/photoprism/proxy.js
+++ b/src/widgets/photoprism/proxy.js
@@ -6,14 +6,14 @@ import createLogger from "utils/logger";
const logger = createLogger("photoprismProxyHandler");
export default async function photoprismProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/pihole/proxy.js b/src/widgets/pihole/proxy.js
index 35873fa92..bf24624d4 100644
--- a/src/widgets/pihole/proxy.js
+++ b/src/widgets/pihole/proxy.js
@@ -33,7 +33,7 @@ async function login(widget, service) {
}
export default async function piholeProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
let endpoint = "stats/summary";
if (!group || !service) {
@@ -41,7 +41,7 @@ export default async function piholeProxyHandler(req, res) {
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.error("Invalid or missing widget for service '%s' in group '%s'", service, group);
return res.status(400).json({ error: "Invalid widget configuration" });
diff --git a/src/widgets/plex/proxy.js b/src/widgets/plex/proxy.js
index d80330654..2956f2809 100644
--- a/src/widgets/plex/proxy.js
+++ b/src/widgets/plex/proxy.js
@@ -16,14 +16,14 @@ const tvCacheKey = `${proxyName}__tv`;
const logger = createLogger(proxyName);
async function getWidget(req) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return null;
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/pyload/proxy.js b/src/widgets/pyload/proxy.js
index d9469d1cb..a380c865d 100644
--- a/src/widgets/pyload/proxy.js
+++ b/src/widgets/pyload/proxy.js
@@ -67,11 +67,11 @@ async function login(loginUrl, service, username, password = "") {
}
export default async function pyloadProxyHandler(req, res) {
- const { group, service, endpoint } = req.query;
+ const { group, service, endpoint, index } = req.query;
try {
if (group && service) {
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (widget) {
const url = new URL(formatApiCall(widgets[widget.type].api, { endpoint, ...widget }));
diff --git a/src/widgets/qbittorrent/component.jsx b/src/widgets/qbittorrent/component.jsx
index e88b26227..d7fb8bf75 100644
--- a/src/widgets/qbittorrent/component.jsx
+++ b/src/widgets/qbittorrent/component.jsx
@@ -1,12 +1,13 @@
import { useTranslation } from "next-i18next";
+import QueueEntry from "../../components/widgets/queue/queueEntry";
+
import Container from "components/services/widget/container";
import Block from "components/services/widget/block";
import useWidgetAPI from "utils/proxy/use-widget-api";
export default function Component({ service }) {
const { t } = useTranslation();
-
const { widget } = service;
const { data: torrentData, error: torrentError } = useWidgetAPI(widget, "torrents");
@@ -29,6 +30,7 @@ export default function Component({ service }) {
let rateDl = 0;
let rateUl = 0;
let completed = 0;
+ const leechTorrents = [];
for (let i = 0; i < torrentData.length; i += 1) {
const torrent = torrentData[i];
@@ -37,16 +39,31 @@ export default function Component({ service }) {
if (torrent.progress === 1) {
completed += 1;
}
+ if (torrent.state.includes("DL") || torrent.state === "downloading") {
+ leechTorrents.push(torrent);
+ }
}
const leech = torrentData.length - completed;
return (
-
-
-
-
-
-
+ <>
+
+
+
+
+
+
+ {widget?.enableLeechProgress &&
+ leechTorrents.map((queueEntry) => (
+
+ ))}
+
);
}
diff --git a/src/widgets/qbittorrent/proxy.js b/src/widgets/qbittorrent/proxy.js
index e1a0f0552..aead75820 100644
--- a/src/widgets/qbittorrent/proxy.js
+++ b/src/widgets/qbittorrent/proxy.js
@@ -21,14 +21,14 @@ async function login(widget) {
}
export default async function qbittorrentProxyHandler(req, res) {
- const { group, service, endpoint } = req.query;
+ const { group, service, endpoint, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/qnap/proxy.js b/src/widgets/qnap/proxy.js
index 508c8a46f..07917d28c 100644
--- a/src/widgets/qnap/proxy.js
+++ b/src/widgets/qnap/proxy.js
@@ -77,14 +77,14 @@ async function apiCall(widget, endpoint, service) {
}
export default async function qnapProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
diff --git a/src/widgets/rutorrent/proxy.js b/src/widgets/rutorrent/proxy.js
index 47c761916..e0ae44fec 100644
--- a/src/widgets/rutorrent/proxy.js
+++ b/src/widgets/rutorrent/proxy.js
@@ -45,10 +45,10 @@ const getTorrentInfo = (data) => ({
});
export default async function rutorrentProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (group && service) {
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (widget) {
const api = widgets?.[widget.type]?.api;
diff --git a/src/widgets/spoolman/component.jsx b/src/widgets/spoolman/component.jsx
new file mode 100644
index 000000000..523ecea79
--- /dev/null
+++ b/src/widgets/spoolman/component.jsx
@@ -0,0 +1,63 @@
+import { useTranslation } from "next-i18next";
+
+import Container from "components/services/widget/container";
+import Block from "components/services/widget/block";
+import useWidgetAPI from "utils/proxy/use-widget-api";
+
+export default function Component({ service }) {
+ const { t } = useTranslation();
+ const { widget } = service;
+
+ // eslint-disable-next-line prefer-const
+ let { data: spoolData, error: spoolError } = useWidgetAPI(widget, "spools");
+
+ if (spoolError) {
+ return
;
+ }
+
+ if (!spoolData) {
+ const nBlocksGuess = widget.spoolIds?.length ?? 4;
+ return (
+
+ {[...Array(nBlocksGuess)].map((_, i) => (
+ // eslint-disable-next-line react/no-array-index-key
+
+ ))}
+
+ );
+ }
+
+ if (spoolData.error || spoolData.message) {
+ return
;
+ }
+
+ if (spoolData.length === 0) {
+ return (
+
+
+
+ );
+ }
+
+ if (widget.spoolIds?.length) {
+ spoolData = spoolData.filter((spool) => widget.spoolIds.includes(spool.id));
+ }
+
+ if (spoolData.length > 4) {
+ spoolData = spoolData.slice(0, 4);
+ }
+
+ return (
+
+ {spoolData.map((spool) => (
+
+ ))}
+
+ );
+}
diff --git a/src/widgets/spoolman/widget.js b/src/widgets/spoolman/widget.js
new file mode 100644
index 000000000..2c8a34757
--- /dev/null
+++ b/src/widgets/spoolman/widget.js
@@ -0,0 +1,14 @@
+import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
+
+const widget = {
+ api: "{url}/api/v1/{endpoint}",
+ proxyHandler: credentialedProxyHandler,
+
+ mappings: {
+ spools: {
+ endpoint: "spool",
+ },
+ },
+};
+
+export default widget;
diff --git a/src/widgets/suwayomi/proxy.js b/src/widgets/suwayomi/proxy.js
index d4d716752..def811ccf 100644
--- a/src/widgets/suwayomi/proxy.js
+++ b/src/widgets/suwayomi/proxy.js
@@ -114,14 +114,14 @@ function extractCounts(responseJSON, fields) {
}
export default async function suwayomiProxyHandler(req, res) {
- const { group, service, endpoint } = req.query;
+ const { group, service, endpoint, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/tailscale/component.jsx b/src/widgets/tailscale/component.jsx
index 3929b2ed1..d3c937d5d 100644
--- a/src/widgets/tailscale/component.jsx
+++ b/src/widgets/tailscale/component.jsx
@@ -11,8 +11,8 @@ export default function Component({ service }) {
const { data: statsData, error: statsError } = useWidgetAPI(widget, "device");
- if (statsError) {
- return
;
+ if (statsError || statsData?.message) {
+ return
;
}
if (!statsData) {
diff --git a/src/widgets/tdarr/proxy.js b/src/widgets/tdarr/proxy.js
index 9e26fdc06..88da30fdf 100644
--- a/src/widgets/tdarr/proxy.js
+++ b/src/widgets/tdarr/proxy.js
@@ -8,14 +8,14 @@ const proxyName = "tdarrProxyHandler";
const logger = createLogger(proxyName);
export default async function tdarrProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/transmission/proxy.js b/src/widgets/transmission/proxy.js
index 823def054..8b8049bc8 100644
--- a/src/widgets/transmission/proxy.js
+++ b/src/widgets/transmission/proxy.js
@@ -11,14 +11,14 @@ const headerCacheKey = `${proxyName}__headers`;
const logger = createLogger(proxyName);
export default async function transmissionProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/unifi/proxy.js b/src/widgets/unifi/proxy.js
index 98c98f377..559065e33 100644
--- a/src/widgets/unifi/proxy.js
+++ b/src/widgets/unifi/proxy.js
@@ -14,13 +14,13 @@ const prefixCacheKey = `${proxyName}__prefix`;
const logger = createLogger(proxyName);
async function getWidget(req) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
let widget = null;
if (group === "unifi_console" && service === "unifi_console") {
// info widget
- const index = req.query?.query ? JSON.parse(req.query.query).index : undefined;
- widget = await getPrivateWidgetOptions("unifi_console", index);
+ const infowidgetIndex = req.query?.query ? JSON.parse(req.query.query).index : undefined;
+ widget = await getPrivateWidgetOptions("unifi_console", infowidgetIndex);
if (!widget) {
logger.debug("Error retrieving settings for this Unifi widget");
return null;
@@ -32,7 +32,7 @@ async function getWidget(req) {
return null;
}
- widget = await getServiceWidget(group, service);
+ widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/urbackup/proxy.js b/src/widgets/urbackup/proxy.js
index 94b8eeff6..4e7a0a8d5 100644
--- a/src/widgets/urbackup/proxy.js
+++ b/src/widgets/urbackup/proxy.js
@@ -3,8 +3,8 @@ import { UrbackupServer } from "urbackup-server-api";
import getServiceWidget from "utils/config/service-helpers";
export default async function urbackupProxyHandler(req, res) {
- const { group, service } = req.query;
- const serviceWidget = await getServiceWidget(group, service);
+ const { group, service, index } = req.query;
+ const serviceWidget = await getServiceWidget(group, service, index);
const server = new UrbackupServer({
url: serviceWidget.url,
diff --git a/src/widgets/watchtower/proxy.js b/src/widgets/watchtower/proxy.js
index b3155a1e9..588d08ee0 100644
--- a/src/widgets/watchtower/proxy.js
+++ b/src/widgets/watchtower/proxy.js
@@ -8,14 +8,14 @@ const proxyName = "watchtowerProxyHandler";
const logger = createLogger(proxyName);
export default async function watchtowerProxyHandler(req, res) {
- const { group, service, endpoint } = req.query;
+ const { group, service, endpoint, index } = req.query;
if (!group || !service) {
logger.debug("Invalid or missing service '%s' or group '%s'", service, group);
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
if (!widget) {
logger.debug("Invalid or missing widget for service '%s' in group '%s'", service, group);
diff --git a/src/widgets/widgets.js b/src/widgets/widgets.js
index 0cad5346d..9d4bb935d 100644
--- a/src/widgets/widgets.js
+++ b/src/widgets/widgets.js
@@ -32,6 +32,7 @@ import gamedig from "./gamedig/widget";
import gatus from "./gatus/widget";
import ghostfolio from "./ghostfolio/widget";
import gitea from "./gitea/widget";
+import gitlab from "./gitlab/widget";
import glances from "./glances/widget";
import gluetun from "./gluetun/widget";
import gotify from "./gotify/widget";
@@ -102,6 +103,7 @@ import sabnzbd from "./sabnzbd/widget";
import scrutiny from "./scrutiny/widget";
import sonarr from "./sonarr/widget";
import speedtest from "./speedtest/widget";
+import spoolman from "./spoolman/widget";
import stash from "./stash/widget";
import stocks from "./stocks/widget";
import strelaysrv from "./strelaysrv/widget";
@@ -163,6 +165,7 @@ const widgets = {
gatus,
ghostfolio,
gitea,
+ gitlab,
glances,
gluetun,
gotify,
@@ -237,6 +240,7 @@ const widgets = {
scrutiny,
sonarr,
speedtest,
+ spoolman,
stash,
stocks,
strelaysrv,
diff --git a/src/widgets/xteve/proxy.js b/src/widgets/xteve/proxy.js
index 421f2b499..453e36456 100644
--- a/src/widgets/xteve/proxy.js
+++ b/src/widgets/xteve/proxy.js
@@ -7,13 +7,13 @@ import getServiceWidget from "utils/config/service-helpers";
const logger = createLogger("xteveProxyHandler");
export default async function xteveProxyHandler(req, res) {
- const { group, service } = req.query;
+ const { group, service, index } = req.query;
if (!group || !service) {
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
const api = widgets?.[widget.type]?.api;
if (!api) {
return res.status(403).json({ error: "Service does not support API calls" });
+### Nested Groups
+
+Groups can be nested by using the same format as the top-level groups.
+
+```yaml
+- Group A:
+ - Service A:
+ href: http://localhost/
+
+ - Group B:
+ - Service B:
+ href: http://localhost/
+
+ - Service C:
+ href: http://localhost/
+```
+
## Services
Services are defined as array entries on groups,
@@ -43,6 +60,60 @@ Services are defined as array entries on groups,
+### Service Widgets
+
+Each service can have widgets attached to it (often matching the service type, but that's not forced).
+
+In addition to the href of the service, you can also specify the target location in which to open that link. See [Link Target](settings.md#link-target) for more details.
+
+Using Emby as an example, this is how you would attach the Emby service widget.
+
+```yaml
+- Emby:
+ icon: emby.png
+ href: http://emby.host.or.ip/
+ description: Movies & TV Shows
+ widget:
+ type: emby
+ url: http://emby.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
+```
+
+#### Multiple Widgets
+
+Each service can have multiple widgets attached to it, for example:
+
+```yaml
+- Emby:
+ icon: emby.png
+ href: http://emby.host.or.ip/
+ description: Movies & TV Shows
+ widgets:
+ - type: emby
+ url: http://emby.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
+ - type: uptimekuma
+ url: http://uptimekuma.host.or.ip:port
+ slug: statuspageslug
+```
+
+#### Field Visibility
+
+Each widget can optionally provide a list of which fields should be visible via the `fields` widget property. If no fields are specified, then all fields will be displayed. The `fields` property must be a valid YAML array of strings. As an example, here is the entry for Sonarr showing only a couple of fields.
+
+**In all cases a widget will work and display all fields without specifying the `fields` property.**
+
+```yaml
+- Sonarr:
+ icon: sonarr.png
+ href: http://sonarr.host.or.ip
+ widget:
+ type: sonarr
+ fields: ["wanted", "queued"]
+ url: http://sonarr.host.or.ip
+ key: apikeyapikeyapikeyapikeyapikey
+```
+
## Descriptions
Services may have descriptions,
@@ -63,7 +134,7 @@ Services may have descriptions,
## Icons
-Services may have an icon attached to them, you can use icons from [Dashboard Icons](https://github.com/walkxcode/dashboard-icons) automatically, by passing the name of the icon, with, or without `.png` or with `.svg` to use the svg version.
+Services may have an icon attached to them, you can use icons from [Dashboard Icons](https://github.com/homarr-labs/dashboard-icons) automatically, by passing the name of the icon, with, or without `.png`, `.webp` or `.svg` to specify the desired version.
You can also specify prefixed icons from:
diff --git a/docs/configs/settings.md b/docs/configs/settings.md
index 2f387a65b..5a32c139f 100644
--- a/docs/configs/settings.md
+++ b/docs/configs/settings.md
@@ -13,6 +13,14 @@ You can customize the title of the page if you'd like.
title: My Awesome Homepage
```
+## Description
+
+You can customize the description of the page if you'd like.
+
+```yaml
+description: A description of my awesome homepage
+```
+
## Start URL
You can customize the start_url as required for installable apps. The default is "/".
@@ -118,6 +126,22 @@ As an example, this would produce the following layout:
+### Icons-Only Layout
+
+You can also specify the an icon-only layout for bookmarks, either like so:
+
+```yaml
+layout:
+ Media:
+ iconsOnly: true
+```
+
+or globally:
+
+```yaml
+bookmarksStyle: icons
+```
+
### Sorting
Service groups and bookmark groups can be mixed in order, **but should use different group names**. If you do not specify any bookmark groups they will all show at the bottom of the page.
@@ -137,6 +161,27 @@ layout:
columns: 3
```
+### Nested Groups
+
+If your services config has nested groups, you can apply settings to these groups by nesting them in the layout block
+and using the same settings. For example
+
+```yaml
+layout:
+ Group A:
+ style: row
+ columns: 4
+ Group C:
+ style: row
+ columns: 2
+ Nested Group A:
+ style: row
+ columns: 2
+ Nested Group B:
+ style: row
+ columns: 2
+```
+
### Headers
You can hide headers for each section in the layout as well by passing `header` as false, like so:
@@ -348,12 +393,12 @@ This can also be set for individual services. Note setting this at the service l
## Providers
-The `providers` section allows you to define shared API provider options and secrets. Currently this allows you to define your weather API keys in secret and is also the location of the Longhorn URL and credentials.
+The `providers` section allows you to define shared API provider options and secrets.
```yaml
providers:
openweathermap: openweathermapapikey
- weatherapi: weatherapiapikey
+ finnhub: yourfinnhubapikeyhere
longhorn:
url: https://longhorn.example.com
username: admin
@@ -363,10 +408,10 @@ providers:
You can then pass `provider` instead of `apiKey` in your widget configuration.
```yaml
-- weatherapi:
+- openweathermap:
latitude: 50.449684
longitude: 30.525026
- provider: weatherapi
+ provider: openweathermap
```
## Quick Launch
diff --git a/docs/installation/k8s.md b/docs/installation/k8s.md
index 7faebda9d..22606462c 100644
--- a/docs/installation/k8s.md
+++ b/docs/installation/k8s.md
@@ -175,6 +175,7 @@ data:
expanded: true
cpu: true
memory: true
+ network: default
- search:
provider: duckduckgo
target: _blank
@@ -209,7 +210,7 @@ rules:
- get
- list
- apiGroups:
- - traefik.containo.us
+ - traefik.io
resources:
- ingressroutes
verbs:
diff --git a/docs/installation/source.md b/docs/installation/source.md
index 42e5fe917..573711a80 100644
--- a/docs/installation/source.md
+++ b/docs/installation/source.md
@@ -23,3 +23,5 @@ Finally, run the server:
```bash
pnpm start
```
+
+When updating homepage versions you will need to re-build the static files i.e. repeat the process above.
diff --git a/docs/troubleshooting/index.md b/docs/troubleshooting/index.md
index 82a7381cf..bbde4cf3c 100644
--- a/docs/troubleshooting/index.md
+++ b/docs/troubleshooting/index.md
@@ -17,7 +17,7 @@ hide:
All service widgets work essentially the same, that is, homepage makes a proxied call to an API made available by that service. The majority of the time widgets don't work it is a configuration issue. Of course, sometimes things do break. Some basic steps to try:
-1. Ensure that you follow the rule mentioned on https://gethomepage.dev/configs/service-widgets/. **Unless otherwise noted, URLs should not end with a / or other API path. Each widget will handle the path on its own.**. This is very important as including a trailing slash can result in an error.
+1. **URLs should not end with a / or other API path. Each widget will handle the path on its own.**. Including a trailing slash can result in an error.
2. Verify the homepage installation can connect to the IP address or host you are using for the widget `url`. This is most simply achieved by pinging the server from the homepage machine, in Docker this means _from inside the container_ itself, e.g.:
diff --git a/docs/widgets/authoring/getting-started.md b/docs/widgets/authoring/getting-started.md
index 4b9126ea7..8e16b9153 100644
--- a/docs/widgets/authoring/getting-started.md
+++ b/docs/widgets/authoring/getting-started.md
@@ -46,16 +46,16 @@ See the [pre-commit documentation](https://pre-commit.com/#install) to get start
In general, homepage is meant to be a dashboard for 'self-hosted' services and we believe it is a small way we can help showcase this kind of software. While exceptions are made, mostly when there is no viable
self-hosted / open-source alternative, we ask that any widgets, etc. are developed primarily for a self-hosted tool.
-## New Feature Guidelines
+## New Feature or Enhancement Guidelines {#new-feature-guidelines}
-- New features should usually be linked to an existing feature request. 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 or enhancements, **no matter how small**, must be linked to an existing feature request. 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 you may want to open a discussion first.
## 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 target a feature request discussion with 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.
+- Please only submit widgets that target a feature request discussion with at least 20 '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.
- Note that we reserve the right to decline widgets for projects that are very young (eg < ~1y) or those with a small reach (eg low GitHub stars). Again, this is in an effort to keep overall widget maintenance under control.
- Widgets should be only one row of blocks
- Widgets should be no more than 4 blocks wide and generally conform to the styling / design choices of other widgets
diff --git a/docs/widgets/authoring/proxies.md b/docs/widgets/authoring/proxies.md
index 15cdb6703..a8b8073e0 100644
--- a/docs/widgets/authoring/proxies.md
+++ b/docs/widgets/authoring/proxies.md
@@ -50,7 +50,7 @@ You can also pass API keys from the widget configuration to the proxy handler, f
### `credentialedProxyHandler`
-A proxy handler that makes authenticated by setting request headers. Credentials are pulled from the widgets configuration.
+A proxy handler that makes authenticated requests by setting request headers. Credentials are pulled from the widgets configuration.
By default the key is passed as an `X-API-Key` header. If you need to pass the key as something else, either add a case to the credentialedProxyHandler or create a new proxy handler.
diff --git a/docs/widgets/index.md b/docs/widgets/index.md
index 8b81ee402..fbb8edc63 100644
--- a/docs/widgets/index.md
+++ b/docs/widgets/index.md
@@ -19,12 +19,17 @@ Service widgets are used to display the status of a service, often a web service
description: Watch movies and TV shows.
server: localhost
container: plex
- widget:
- type: tautulli
- url: http://172.16.1.1:8181
- key: aabbccddeeffgghhiijjkkllmmnnoo
+ widgets:
+ - type: tautulli
+ url: http://172.16.1.1:8181
+ key: aabbccddeeffgghhiijjkkllmmnnoo
+ - type: uptimekuma
+ url: http://172.16.1.2:8080
+ slug: aaaaaaabbbbb
```
+More detail on configuring service widgets can be found in the [Service Widgets Config](../configs/services.md) section.
+
## Info Widgets
Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yaml` file. Here's an example:
@@ -36,3 +41,5 @@ Info widgets are used to display information in the header, often about your sys
longitude: -117.51
cache: 5
```
+
+More detail on configuring info widgets can be found in the [Info Widgets Config](../configs/info-widgets.md) section.
diff --git a/docs/widgets/info/openmeteo.md b/docs/widgets/info/openmeteo.md
index fb5bb1717..ec84ab174 100644
--- a/docs/widgets/info/openmeteo.md
+++ b/docs/widgets/info/openmeteo.md
@@ -3,7 +3,7 @@ title: Open-Meteo
description: Open-Meteo Information Widget Configuration
---
-No registration is required at all! See [https://open-meteo.com/en/docs](https://open-meteo.com/en/docs)
+Homepage's recommended weather widget. No registration is required at all! See [https://open-meteo.com/en/docs](https://open-meteo.com/en/docs)
```yaml
- openmeteo:
diff --git a/docs/widgets/info/resources.md b/docs/widgets/info/resources.md
index 19323dc30..7fcf9c5cd 100644
--- a/docs/widgets/info/resources.md
+++ b/docs/widgets/info/resources.md
@@ -24,9 +24,10 @@ _Note: unfortunately, the package used for getting CPU temp ([systeminformation]
tempmin: 0 # optional, minimum cpu temp
tempmax: 100 # optional, maximum cpu temp
uptime: true
- units: imperial # only used by cpu temp
+ units: imperial # only used by cpu temp, options: 'imperial' or 'metric'
refresh: 3000 # optional, in ms
diskUnits: bytes # optional, bytes (default) or bbytes. Only applies to disk
+ network: true # optional, uses 'default' if true or specify a network interface name
```
You can also pass a `label` option, which allows you to group resources under named sections,
diff --git a/docs/widgets/info/unifi_controller.md b/docs/widgets/info/unifi_controller.md
index b77d8ed00..e16ca40b0 100644
--- a/docs/widgets/info/unifi_controller.md
+++ b/docs/widgets/info/unifi_controller.md
@@ -7,7 +7,7 @@ _(Find the Unifi Controller service widget [here](../services/unifi-controller.m
You can display general connectivity status from your Unifi (Network) Controller.
-!!!
+!!! warning
When authenticating you will want to use a local account that has at least read privileges.
diff --git a/docs/widgets/info/weather.md b/docs/widgets/info/weather.md
deleted file mode 100644
index ab13b6736..000000000
--- a/docs/widgets/info/weather.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-title: Weather API
-description: Weather API Information Widget Configuration
----
-
-**Note: this widget is considered 'deprecated' since there is no longer a free Weather API tier for new members. See the openmeteo or openweathermap widgets for alternatives.**
-
-The free tier is all that's required, you will need to [register](https://www.weatherapi.com/signup.aspx) and grab your API key.
-
-```yaml
-- weatherapi:
- label: Kyiv # optional
- latitude: 50.449684
- longitude: 30.525026
- units: metric # or imperial
- apiKey: yourweatherapikey
- cache: 5 # Time in minutes to cache API responses, to stay within limits
- format: # optional, Intl.NumberFormat options
- maximumFractionDigits: 1
-```
-
-You can optionally not pass a `latitude` and `longitude` and the widget will use your current location (requires a secure context, eg. HTTPS).
diff --git a/docs/widgets/services/authentik.md b/docs/widgets/services/authentik.md
index 8968f4bfb..f4dafd40e 100644
--- a/docs/widgets/services/authentik.md
+++ b/docs/widgets/services/authentik.md
@@ -20,6 +20,6 @@ Allowed fields: `["users", "loginsLast24H", "failedLoginsLast24H"]`.
```yaml
widget:
type: authentik
- url: http://authentik.host.or.ip:22070
+ url: http://authentik.host.or.ip:port
key: api_token
```
diff --git a/docs/widgets/services/beszel.md b/docs/widgets/services/beszel.md
index 6a5cc2691..99715191b 100644
--- a/docs/widgets/services/beszel.md
+++ b/docs/widgets/services/beszel.md
@@ -7,11 +7,16 @@ Learn more about [Beszel](https://github.com/henrygd/beszel)
The widget has two modes, a single system with detailed info if `systemId` is provided, or an overview of all systems if `systemId` is not provided.
-The `systemID` in the `id` field on the collections page of Beszel.
+The `systemID` is the `id` field on the collections page of Beszel under the PocketBase admin panel. You can also use the 'nice name' from the Beszel UI.
Allowed fields for 'overview' mode: `["systems", "up"]`
Allowed fields for a single system: `["name", "status", "updated", "cpu", "memory", "disk", "network"]`
+| Beszel Version | Homepage Widget Version |
+| -------------- | ----------------------- |
+| < 0.9.0 | 1 (default) |
+| >= 0.9.0 | 2 |
+
```yaml
widget:
type: beszel
@@ -19,4 +24,5 @@ widget:
username: username # email
password: password
systemId: systemId # optional
+ version: 2 # optional, default is 1
```
diff --git a/docs/widgets/services/customapi.md b/docs/widgets/services/customapi.md
index c392d942c..0deb8294e 100644
--- a/docs/widgets/services/customapi.md
+++ b/docs/widgets/services/customapi.md
@@ -62,10 +62,12 @@ widget:
format: size
```
-Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `size`, `date` and `relativeDate`.
+Supported formats for the values are `text`, `number`, `float`, `percent`, `duration`, `bytes`, `bitrate`, `size`, `date` and `relativeDate`.
The `dateStyle` and `timeStyle` options of the `date` format are passed directly to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat) and the `style` and `numeric` options of `relativeDate` are passed to [Intl.RelativeTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat).
+The `duration` format expects the duration to be specified in seconds. The `scale` transformation tool can be used if a conversion is required.
+
The `size` format will return the length of the array or string, or the number of keys in an object. This is then formatted as `number`.
## Example
diff --git a/docs/widgets/services/deluge.md b/docs/widgets/services/deluge.md
index 817ae8310..8b925a9af 100644
--- a/docs/widgets/services/deluge.md
+++ b/docs/widgets/services/deluge.md
@@ -14,4 +14,5 @@ widget:
type: deluge
url: http://deluge.host.or.ip
password: password # webui password
+ enableLeechProgress: true # optional, defaults to false
```
diff --git a/docs/widgets/services/esphome.md b/docs/widgets/services/esphome.md
index 07e511e37..e5dacb96a 100644
--- a/docs/widgets/services/esphome.md
+++ b/docs/widgets/services/esphome.md
@@ -16,5 +16,6 @@ To group both `offline` and `unknown` devices together, users should use the `of
widget:
type: esphome
url: http://esphome.host.or.ip:port
- key: myesphomecookie # only if auth enabled, get the value from a request from the frontend e.g. `authenticated=myesphomecookie`
+ username: myesphomeuser # only if auth enabled
+ password: myesphomepass # only if auth enabled
```
diff --git a/docs/widgets/services/evcc.md b/docs/widgets/services/evcc.md
index 108b6eb42..1d3af2ba5 100644
--- a/docs/widgets/services/evcc.md
+++ b/docs/widgets/services/evcc.md
@@ -3,7 +3,7 @@ title: EVCC
description: EVCC Widget Configuration
---
-Learn more about [EVSS](https://github.com/evcc-io/evcc).
+Learn more about [EVCC](https://github.com/evcc-io/evcc).
Allowed fields: `["pv_power", "grid_power", "home_power", "charge_power]`.
diff --git a/docs/widgets/services/gitlab.md b/docs/widgets/services/gitlab.md
new file mode 100644
index 000000000..a92434d83
--- /dev/null
+++ b/docs/widgets/services/gitlab.md
@@ -0,0 +1,20 @@
+---
+title: Gitlab
+description: Gitlab Widget Configuration
+---
+
+Learn more about [Gitlab](https://gitlab.com).
+
+API requires a personal access token with either `read_api` or `api` permission. See the [gitlab documentation](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) for details on generating one.
+
+Your Gitlab user ID can be found on [your profile page](https://support.circleci.com/hc/en-us/articles/20761157174043-How-to-find-your-GitLab-User-ID).
+
+Allowed fields: `["events", "issues", "merges", "projects"]`.
+
+```yaml
+widget:
+ type: gitlab
+ url: http://gitlab.host.or.ip:port
+ key: personal-access-token
+ user_id: 123456
+```
diff --git a/docs/widgets/services/glances.md b/docs/widgets/services/glances.md
index 562cf57a2..d28462eb1 100644
--- a/docs/widgets/services/glances.md
+++ b/docs/widgets/services/glances.md
@@ -51,6 +51,8 @@ The metric field in the configuration determines the type of system monitoring d
`process`: Top 5 processes based on CPU usage. Gives an overview of which processes are consuming the most resources.
+`containers`: Docker or Kubernetes containers list. Shows up to 5 containers running on the system and their resource usage.
+
`network: