{value}
{label}
diff --git a/src/pages/api/widgets/resources.js b/src/pages/api/widgets/resources.js
index 66449bff0..4df544e82 100644
--- a/src/pages/api/widgets/resources.js
+++ b/src/pages/api/widgets/resources.js
@@ -7,7 +7,7 @@ const logger = createLogger("resources");
const si = require("systeminformation");
export default async function handler(req, res) {
- const { type, target } = req.query;
+ const { type, target, interfaceName = "default" } = req.query;
if (type === "cpu") {
const load = await si.currentLoad();
@@ -57,6 +57,32 @@ export default async function handler(req, res) {
});
}
+ if (type === "network") {
+ let networkData = await si.networkStats();
+ let interfaceDefault;
+ logger.debug("networkData:", JSON.stringify(networkData));
+ if (interfaceName && interfaceName !== "default") {
+ networkData = networkData.filter((network) => network.iface === interfaceName).at(0);
+ if (!networkData) {
+ return res.status(404).json({
+ error: "Interface not found",
+ });
+ }
+ } else {
+ interfaceDefault = await si.networkInterfaceDefault();
+ networkData = networkData.filter((network) => network.iface === interfaceDefault).at(0);
+ if (!networkData) {
+ return res.status(404).json({
+ error: "Default interface not found",
+ });
+ }
+ }
+ return res.status(200).json({
+ network: networkData,
+ interface: interfaceName !== "default" ? interfaceName : interfaceDefault,
+ });
+ }
+
return res.status(400).json({
error: "invalid type",
});
From cbf304a4c81df5bbec1164bae858a3d684867bc8 Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Sun, 24 Nov 2024 22:43:17 -0800
Subject: [PATCH 02/43] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4f898387d..588209428 100644
--- a/README.md
+++ b/README.md
@@ -52,7 +52,7 @@ Homepage has built-in support for Docker, and can automatically discover and add
## Service Widgets
-Homepage also has support for over 100 3rd party services, including all popular starr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd party APIs. See the [Service](https://gethomepage.dev/widgets/) page for more information.
+Homepage also has support for hundreds of 3rd-party services, including all popular \*arr apps, and most popular self-hosted apps. Some examples include: Radarr, Sonarr, Lidarr, Bazarr, Ombi, Tautulli, Plex, Jellyfin, Emby, Transmission, qBittorrent, Deluge, Jackett, NZBGet, SABnzbd, etc. As well as service integrations, Homepage also has a number of information providers, sourcing information from a variety of external 3rd-party APIs. See the [Service](https://gethomepage.dev/widgets/) page for more information.
## Information Widgets
From 385511f773daea10bd27c5673231582131f00b86 Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Sun, 24 Nov 2024 23:11:07 -0800
Subject: [PATCH 03/43] Fix: resources network better startup behavior
---
src/components/widgets/resources/network.jsx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/components/widgets/resources/network.jsx b/src/components/widgets/resources/network.jsx
index 5b5cc0043..a2a3acac5 100644
--- a/src/components/widgets/resources/network.jsx
+++ b/src/components/widgets/resources/network.jsx
@@ -18,7 +18,7 @@ export default function Network({ options, refresh = 1500 }) {
return
-
);
}
diff --git a/src/pages/api/services/proxy.js b/src/pages/api/services/proxy.js
index 90280c3dd..3f8adc883 100644
--- a/src/pages/api/services/proxy.js
+++ b/src/pages/api/services/proxy.js
@@ -9,8 +9,8 @@ const logger = createLogger("servicesProxy");
export default async function handler(req, res) {
try {
- const { service, group } = req.query;
- const serviceWidget = await getServiceWidget(group, service);
+ const { service, group, index } = req.query;
+ const serviceWidget = await getServiceWidget(group, service, index);
let type = serviceWidget?.type;
// exceptions
@@ -41,7 +41,7 @@ export default async function handler(req, res) {
const endpoint = mapping?.endpoint;
const endpointProxy = mapping?.proxyHandler || serviceProxyHandler;
- if (mapping.method && mapping.method !== req.method) {
+ if (mapping?.method && mapping.method !== req.method) {
logger.debug("Unsupported method: %s", req.method);
return res.status(403).json({ error: "Unsupported method" });
}
diff --git a/src/utils/config/service-helpers.js b/src/utils/config/service-helpers.js
index ea82c7352..e6ef6173e 100644
--- a/src/utils/config/service-helpers.js
+++ b/src/utils/config/service-helpers.js
@@ -354,8 +354,12 @@ export function cleanServiceGroups(groups) {
if (typeof cleanedService.weight !== "number") {
cleanedService.weight = 0;
}
-
+ if (!cleanedService.widgets) cleanedService.widgets = [];
if (cleanedService.widget) {
+ cleanedService.widgets.push(cleanedService.widget);
+ delete cleanedService.widget;
+ }
+ cleanedService.widgets = cleanedService.widgets.map((widgetData, index) => {
// whitelisted set of keys to pass to the frontend
// alphabetical, grouped by widget(s)
const {
@@ -495,7 +499,7 @@ export function cleanServiceGroups(groups) {
// spoolman
spoolIds,
- } = cleanedService.widget;
+ } = widgetData;
let fieldsList = fields;
if (typeof fields === "string") {
@@ -507,160 +511,160 @@ export function cleanServiceGroups(groups) {
}
}
- cleanedService.widget = {
+ const widget = {
type,
fields: fieldsList || null,
hide_errors: hideErrors || false,
service_name: service.name,
service_group: serviceGroup.name,
+ index,
};
if (type === "azuredevops") {
- if (userEmail) cleanedService.widget.userEmail = userEmail;
- if (repositoryId) cleanedService.widget.repositoryId = repositoryId;
+ if (userEmail) widget.userEmail = userEmail;
+ if (repositoryId) widget.repositoryId = repositoryId;
}
if (type === "beszel") {
- if (systemId) cleanedService.widget.systemId = systemId;
+ if (systemId) widget.systemId = systemId;
}
if (type === "coinmarketcap") {
- if (currency) cleanedService.widget.currency = currency;
- if (symbols) cleanedService.widget.symbols = symbols;
- if (slugs) cleanedService.widget.slugs = slugs;
- if (defaultinterval) cleanedService.widget.defaultinterval = defaultinterval;
+ if (currency) widget.currency = currency;
+ if (symbols) widget.symbols = symbols;
+ if (slugs) widget.slugs = slugs;
+ if (defaultinterval) widget.defaultinterval = defaultinterval;
}
if (type === "docker") {
- if (server) cleanedService.widget.server = server;
- if (container) cleanedService.widget.container = container;
+ if (server) widget.server = server;
+ if (container) widget.container = container;
}
if (type === "unifi") {
- if (site) cleanedService.widget.site = site;
+ if (site) widget.site = site;
}
if (type === "proxmox") {
- if (node) cleanedService.widget.node = node;
+ if (node) widget.node = node;
}
if (type === "kubernetes") {
- if (namespace) cleanedService.widget.namespace = namespace;
- if (app) cleanedService.widget.app = app;
- if (podSelector) cleanedService.widget.podSelector = podSelector;
+ if (namespace) widget.namespace = namespace;
+ if (app) widget.app = app;
+ if (podSelector) widget.podSelector = podSelector;
}
if (type === "iframe") {
- if (src) cleanedService.widget.src = src;
- if (classes) cleanedService.widget.classes = classes;
- if (referrerPolicy) cleanedService.widget.referrerPolicy = referrerPolicy;
- if (allowPolicy) cleanedService.widget.allowPolicy = allowPolicy;
- if (allowFullscreen) cleanedService.widget.allowFullscreen = allowFullscreen;
- if (loadingStrategy) cleanedService.widget.loadingStrategy = loadingStrategy;
- if (allowScrolling) cleanedService.widget.allowScrolling = allowScrolling;
- if (refreshInterval) cleanedService.widget.refreshInterval = refreshInterval;
+ if (src) widget.src = src;
+ if (classes) widget.classes = classes;
+ if (referrerPolicy) widget.referrerPolicy = referrerPolicy;
+ if (allowPolicy) widget.allowPolicy = allowPolicy;
+ if (allowFullscreen) widget.allowFullscreen = allowFullscreen;
+ if (loadingStrategy) widget.loadingStrategy = loadingStrategy;
+ if (allowScrolling) widget.allowScrolling = allowScrolling;
+ if (refreshInterval) widget.refreshInterval = refreshInterval;
}
if (["opnsense", "pfsense"].includes(type)) {
- if (wan) cleanedService.widget.wan = wan;
+ if (wan) widget.wan = wan;
}
if (["emby", "jellyfin"].includes(type)) {
- if (enableBlocks !== undefined) cleanedService.widget.enableBlocks = JSON.parse(enableBlocks);
- if (enableNowPlaying !== undefined) cleanedService.widget.enableNowPlaying = JSON.parse(enableNowPlaying);
+ if (enableBlocks !== undefined) widget.enableBlocks = JSON.parse(enableBlocks);
+ if (enableNowPlaying !== undefined) widget.enableNowPlaying = JSON.parse(enableNowPlaying);
}
if (["emby", "jellyfin", "tautulli"].includes(type)) {
if (expandOneStreamToTwoRows !== undefined)
- cleanedService.widget.expandOneStreamToTwoRows = !!JSON.parse(expandOneStreamToTwoRows);
- if (showEpisodeNumber !== undefined)
- cleanedService.widget.showEpisodeNumber = !!JSON.parse(showEpisodeNumber);
- if (enableUser !== undefined) cleanedService.widget.enableUser = !!JSON.parse(enableUser);
+ widget.expandOneStreamToTwoRows = !!JSON.parse(expandOneStreamToTwoRows);
+ if (showEpisodeNumber !== undefined) widget.showEpisodeNumber = !!JSON.parse(showEpisodeNumber);
+ if (enableUser !== undefined) widget.enableUser = !!JSON.parse(enableUser);
}
if (["sonarr", "radarr"].includes(type)) {
- if (enableQueue !== undefined) cleanedService.widget.enableQueue = JSON.parse(enableQueue);
+ if (enableQueue !== undefined) widget.enableQueue = JSON.parse(enableQueue);
}
if (type === "truenas") {
- if (enablePools !== undefined) cleanedService.widget.enablePools = JSON.parse(enablePools);
- if (nasType !== undefined) cleanedService.widget.nasType = nasType;
+ if (enablePools !== undefined) widget.enablePools = JSON.parse(enablePools);
+ if (nasType !== undefined) widget.nasType = nasType;
}
if (["diskstation", "qnap"].includes(type)) {
- if (volume) cleanedService.widget.volume = volume;
+ if (volume) widget.volume = volume;
}
if (type === "kopia") {
- if (snapshotHost) cleanedService.widget.snapshotHost = snapshotHost;
- if (snapshotPath) cleanedService.widget.snapshotPath = snapshotPath;
+ if (snapshotHost) widget.snapshotHost = snapshotHost;
+ if (snapshotPath) widget.snapshotPath = snapshotPath;
}
if (["glances", "immich", "mealie", "pfsense", "pihole"].includes(type)) {
- if (version) cleanedService.widget.version = parseInt(version, 10);
+ if (version) widget.version = parseInt(version, 10);
}
if (type === "glances") {
- if (metric) cleanedService.widget.metric = metric;
+ if (metric) widget.metric = metric;
if (chart !== undefined) {
- cleanedService.widget.chart = chart;
+ widget.chart = chart;
} else {
- cleanedService.widget.chart = true;
+ widget.chart = true;
}
- if (refreshInterval) cleanedService.widget.refreshInterval = refreshInterval;
- if (pointsLimit) cleanedService.widget.pointsLimit = pointsLimit;
- if (diskUnits) cleanedService.widget.diskUnits = diskUnits;
+ if (refreshInterval) widget.refreshInterval = refreshInterval;
+ if (pointsLimit) widget.pointsLimit = pointsLimit;
+ if (diskUnits) widget.diskUnits = diskUnits;
}
if (type === "mjpeg") {
- if (stream) cleanedService.widget.stream = stream;
- if (fit) cleanedService.widget.fit = fit;
+ if (stream) widget.stream = stream;
+ if (fit) widget.fit = fit;
}
if (type === "openmediavault") {
- if (method) cleanedService.widget.method = method;
+ if (method) widget.method = method;
}
if (type === "openwrt") {
- if (interfaceName) cleanedService.widget.interfaceName = interfaceName;
+ if (interfaceName) widget.interfaceName = interfaceName;
}
if (type === "customapi") {
- if (mappings) cleanedService.widget.mappings = mappings;
- if (display) cleanedService.widget.display = display;
- if (refreshInterval) cleanedService.widget.refreshInterval = refreshInterval;
+ if (mappings) widget.mappings = mappings;
+ if (display) widget.display = display;
+ if (refreshInterval) widget.refreshInterval = refreshInterval;
}
if (type === "calendar") {
- if (integrations) cleanedService.widget.integrations = integrations;
- if (firstDayInWeek) cleanedService.widget.firstDayInWeek = firstDayInWeek;
- if (view) cleanedService.widget.view = view;
- if (maxEvents) cleanedService.widget.maxEvents = maxEvents;
- if (previousDays) cleanedService.widget.previousDays = previousDays;
- if (showTime) cleanedService.widget.showTime = showTime;
- if (timezone) cleanedService.widget.timezone = timezone;
+ if (integrations) widget.integrations = integrations;
+ if (firstDayInWeek) widget.firstDayInWeek = firstDayInWeek;
+ if (view) widget.view = view;
+ if (maxEvents) widget.maxEvents = maxEvents;
+ if (previousDays) widget.previousDays = previousDays;
+ if (showTime) widget.showTime = showTime;
+ if (timezone) widget.timezone = timezone;
}
if (type === "hdhomerun") {
- if (tuner !== undefined) cleanedService.widget.tuner = tuner;
+ if (tuner !== undefined) widget.tuner = tuner;
}
if (type === "healthchecks") {
- if (uuid !== undefined) cleanedService.widget.uuid = uuid;
+ if (uuid !== undefined) widget.uuid = uuid;
}
if (type === "speedtest") {
if (bitratePrecision !== undefined) {
- cleanedService.widget.bitratePrecision = parseInt(bitratePrecision, 10);
+ widget.bitratePrecision = parseInt(bitratePrecision, 10);
}
}
if (type === "stocks") {
- if (watchlist) cleanedService.widget.watchlist = watchlist;
- if (showUSMarketStatus) cleanedService.widget.showUSMarketStatus = showUSMarketStatus;
+ if (watchlist) widget.watchlist = watchlist;
+ if (showUSMarketStatus) widget.showUSMarketStatus = showUSMarketStatus;
}
if (type === "wgeasy") {
- if (threshold !== undefined) cleanedService.widget.threshold = parseInt(threshold, 10);
+ if (threshold !== undefined) widget.threshold = parseInt(threshold, 10);
}
if (type === "frigate") {
- if (enableRecentEvents !== undefined) cleanedService.widget.enableRecentEvents = enableRecentEvents;
+ if (enableRecentEvents !== undefined) widget.enableRecentEvents = enableRecentEvents;
}
if (type === "technitium") {
- if (range !== undefined) cleanedService.widget.range = range;
+ if (range !== undefined) widget.range = range;
}
if (type === "lubelogger") {
- if (vehicleID !== undefined) cleanedService.widget.vehicleID = parseInt(vehicleID, 10);
+ if (vehicleID !== undefined) widget.vehicleID = parseInt(vehicleID, 10);
}
if (type === "vikunja") {
- if (enableTaskList !== undefined) cleanedService.widget.enableTaskList = !!enableTaskList;
+ if (enableTaskList !== undefined) widget.enableTaskList = !!enableTaskList;
}
if (type === "prometheusmetric") {
- if (metrics) cleanedService.widget.metrics = metrics;
- if (refreshInterval) cleanedService.widget.refreshInterval = refreshInterval;
+ if (metrics) widget.metrics = metrics;
+ if (refreshInterval) widget.refreshInterval = refreshInterval;
}
if (type === "spoolman") {
- if (spoolIds !== undefined) cleanedService.widget.spoolIds = spoolIds;
+ if (spoolIds !== undefined) widget.spoolIds = spoolIds;
}
- }
-
+ return widget;
+ });
return cleanedService;
}),
}));
@@ -693,12 +697,11 @@ export async function getServiceItem(group, service) {
return false;
}
-export default async function getServiceWidget(group, service) {
+export default async function getServiceWidget(group, service, index) {
const serviceItem = await getServiceItem(group, service);
if (serviceItem) {
- const { widget } = serviceItem;
- return widget;
+ const { widget, widgets } = serviceItem;
+ return index > -1 && widgets ? widgets[index] : widget;
}
-
return false;
}
diff --git a/src/utils/proxy/api-helpers.js b/src/utils/proxy/api-helpers.js
index 8e0682dbc..a02ea6233 100644
--- a/src/utils/proxy/api-helpers.js
+++ b/src/utils/proxy/api-helpers.js
@@ -12,6 +12,7 @@ export function getURLSearchParams(widget, endpoint) {
const params = new URLSearchParams({
group: widget.service_group,
service: widget.service_name,
+ index: widget.index,
});
if (endpoint) {
params.append("endpoint", endpoint);
diff --git a/src/utils/proxy/handlers/credentialed.js b/src/utils/proxy/handlers/credentialed.js
index cbe0422ae..cea95196a 100644
--- a/src/utils/proxy/handlers/credentialed.js
+++ b/src/utils/proxy/handlers/credentialed.js
@@ -9,10 +9,10 @@ import widgets from "widgets/widgets";
const logger = createLogger("credentialedProxyHandler");
export default async function credentialedProxyHandler(req, res, map) {
- 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/utils/proxy/handlers/generic.js b/src/utils/proxy/handlers/generic.js
index c6b9236b3..2e788a98c 100644
--- a/src/utils/proxy/handlers/generic.js
+++ b/src/utils/proxy/handlers/generic.js
@@ -8,10 +8,10 @@ import widgets from "widgets/widgets";
const logger = createLogger("genericProxyHandler");
export default async function genericProxyHandler(req, res, map) {
- 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/utils/proxy/handlers/jsonrpc.js b/src/utils/proxy/handlers/jsonrpc.js
index 3974dbdc3..f9fb18832 100644
--- a/src/utils/proxy/handlers/jsonrpc.js
+++ b/src/utils/proxy/handlers/jsonrpc.js
@@ -65,10 +65,10 @@ export async function sendJsonRpcRequest(url, method, params, widget) {
}
export default async function jsonrpcProxyHandler(req, res) {
- const { group, service, endpoint: method } = req.query;
+ const { group, service, endpoint: method, index } = req.query;
if (group && service) {
- const widget = await getServiceWidget(group, service);
+ const widget = await getServiceWidget(group, service, index);
const api = widgets?.[widget.type]?.api;
const [, mapping] = Object.entries(widgets?.[widget.type]?.mappings).find(([, value]) => value.endpoint === method);
diff --git a/src/utils/proxy/handlers/synology.js b/src/utils/proxy/handlers/synology.js
index be44e810a..030e53bad 100644
--- a/src/utils/proxy/handlers/synology.js
+++ b/src/utils/proxy/handlers/synology.js
@@ -131,13 +131,13 @@ function toError(url, synologyError) {
}
export default async function synologyProxyHandler(req, res) {
- const { group, service, endpoint } = req.query;
+ const { group, service, endpoint, index } = req.query;
if (!group || !service) {
return res.status(400).json({ error: "Invalid proxy service type" });
}
- const serviceWidget = await getServiceWidget(group, service);
+ const serviceWidget = await getServiceWidget(group, service, index);
const widget = widgets?.[serviceWidget.type];
const mapping = widget?.mappings?.[endpoint];
if (!widget.api || !mapping) {
diff --git a/src/widgets/audiobookshelf/proxy.js b/src/widgets/audiobookshelf/proxy.js
index 9701c1feb..1a89736b1 100644
--- a/src/widgets/audiobookshelf/proxy.js
+++ b/src/widgets/audiobookshelf/proxy.js
@@ -23,14 +23,14 @@ async function retrieveFromAPI(url, key) {
}
export default async function audiobookshelfProxyHandler(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/beszel/proxy.js b/src/widgets/beszel/proxy.js
index 04083e420..61bc969b4 100644
--- a/src/widgets/beszel/proxy.js
+++ b/src/widgets/beszel/proxy.js
@@ -34,10 +34,10 @@ async function login(loginUrl, username, password, service) {
}
export default async function beszelProxyHandler(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/calendar/proxy.js b/src/widgets/calendar/proxy.js
index cf754424f..d36f30c90 100644
--- a/src/widgets/calendar/proxy.js
+++ b/src/widgets/calendar/proxy.js
@@ -5,10 +5,10 @@ import createLogger from "utils/logger";
const logger = createLogger("calendarProxyHandler");
export default async function calendarProxyHandler(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);
const integration = widget.integrations?.find((i) => i.name === endpoint);
if (integration) {
diff --git a/src/widgets/crowdsec/proxy.js b/src/widgets/crowdsec/proxy.js
index e78fbc5ef..85803845b 100644
--- a/src/widgets/crowdsec/proxy.js
+++ b/src/widgets/crowdsec/proxy.js
@@ -35,14 +35,14 @@ async function login(widget, service) {
}
export default async function crowdsecProxyHandler(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/deluge/proxy.js b/src/widgets/deluge/proxy.js
index b86873a89..613296978 100644
--- a/src/widgets/deluge/proxy.js
+++ b/src/widgets/deluge/proxy.js
@@ -40,14 +40,14 @@ function login(url, password) {
}
export default async function delugeProxyHandler(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/flood/proxy.js b/src/widgets/flood/proxy.js
index 3345ad7b2..e0c101731 100644
--- a/src/widgets/flood/proxy.js
+++ b/src/widgets/flood/proxy.js
@@ -28,14 +28,14 @@ async function login(widget) {
}
export default async function floodProxyHandler(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/freshrss/proxy.js b/src/widgets/freshrss/proxy.js
index c08e5c871..881094bd7 100644
--- a/src/widgets/freshrss/proxy.js
+++ b/src/widgets/freshrss/proxy.js
@@ -74,14 +74,14 @@ async function apiCall(widget, endpoint, service) {
}
export default async function freshrssProxyHandler(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/fritzbox/proxy.js b/src/widgets/fritzbox/proxy.js
index a0a22d8b5..d1a66d979 100644
--- a/src/widgets/fritzbox/proxy.js
+++ b/src/widgets/fritzbox/proxy.js
@@ -46,8 +46,8 @@ async function requestEndpoint(apiBaseUrl, service, action) {
}
export default async function fritzboxProxyHandler(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);
if (!serviceWidget) {
res.status(500).json({ error: { message: "Service widget not found" } });
diff --git a/src/widgets/gamedig/proxy.js b/src/widgets/gamedig/proxy.js
index 05fa615c1..ecf6e4c68 100644
--- a/src/widgets/gamedig/proxy.js
+++ b/src/widgets/gamedig/proxy.js
@@ -7,8 +7,8 @@ const proxyName = "gamedigProxyHandler";
const logger = createLogger(proxyName);
export default async function gamedigProxyHandler(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 {
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/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/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/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/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" });
From be8363cc3514749f54c5060c6548138129612e82 Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Wed, 27 Nov 2024 17:01:47 -0800
Subject: [PATCH 05/43] Feature: nested groups (#4346)
---
src/components/services/group.jsx | 33 ++++++++--
src/components/services/item.jsx | 6 +-
src/components/services/list.jsx | 4 +-
src/components/services/ping.jsx | 4 +-
src/components/services/site-monitor.jsx | 4 +-
src/pages/api/ping.js | 6 +-
src/pages/api/siteMonitor.js | 6 +-
src/pages/index.jsx | 6 +-
src/utils/config/api-response.js | 24 ++++++--
src/utils/config/service-helpers.js | 77 ++++++++++++++++--------
10 files changed, 117 insertions(+), 53 deletions(-)
diff --git a/src/components/services/group.jsx b/src/components/services/group.jsx
index cdbb89f3b..f25f7ec10 100644
--- a/src/components/services/group.jsx
+++ b/src/components/services/group.jsx
@@ -3,12 +3,13 @@ import classNames from "classnames";
import { Disclosure, Transition } from "@headlessui/react";
import { MdKeyboardArrowDown } from "react-icons/md";
+import { columnMap } from "../../utils/layout/columns";
+
import List from "components/services/list";
import ResolvedIcon from "components/resolvedicon";
export default function ServicesGroup({
group,
- services,
layout,
fiveColumns,
disableCollapse,
@@ -23,7 +24,7 @@ export default function ServicesGroup({
return (
{t("widget.missing_type", { type: service.widget.type })}
+ {t("widget.missing_type", { type: widget.type })}
)}
-
diff --git a/src/components/services/item.jsx b/src/components/services/item.jsx
index 54560d6f2..adf5fc974 100644
--- a/src/components/services/item.jsx
+++ b/src/components/services/item.jsx
@@ -12,7 +12,7 @@ import Kubernetes from "widgets/kubernetes/component";
import { SettingsContext } from "utils/contexts/settings";
import ResolvedIcon from "components/resolvedicon";
-export default function Item({ service, group, useEqualHeights }) {
+export default function Item({ service, groupName, useEqualHeights }) {
const hasLink = service.href && service.href !== "#";
const { settings } = useContext(SettingsContext);
const showStats = service.showStats === false ? false : settings.showStats;
@@ -90,14 +90,14 @@ export default function Item({ service, group, useEqualHeights }) {
>
{service.ping && (
- {services.name} + {group.name}
+ {group.groups.map((subgroup) => (
+
+ )}
-
)}
{service.siteMonitor && (
-
)}
diff --git a/src/components/services/list.jsx b/src/components/services/list.jsx
index f3fd6e2ae..c15d6aed8 100644
--- a/src/components/services/list.jsx
+++ b/src/components/services/list.jsx
@@ -4,7 +4,7 @@ import { columnMap } from "../../utils/layout/columns";
import Item from "components/services/item";
-export default function List({ group, services, layout, useEqualHeights }) {
+export default function List({ groupName, services, layout, useEqualHeights }) {
return (
- s).join("-")}
service={service}
- group={group}
+ groupName={groupName}
useEqualHeights={layout?.useEqualHeights ?? useEqualHeights}
/>
))}
diff --git a/src/components/services/ping.jsx b/src/components/services/ping.jsx
index f72d40b3a..670f9d4bf 100644
--- a/src/components/services/ping.jsx
+++ b/src/components/services/ping.jsx
@@ -1,9 +1,9 @@
import { useTranslation } from "react-i18next";
import useSWR from "swr";
-export default function Ping({ group, service, style }) {
+export default function Ping({ groupName, serviceName, style }) {
const { t } = useTranslation();
- const { data, error } = useSWR(`/api/ping?${new URLSearchParams({ group, service }).toString()}`, {
+ const { data, error } = useSWR(`/api/ping?${new URLSearchParams({ groupName, serviceName }).toString()}`, {
refreshInterval: 30000,
});
diff --git a/src/components/services/site-monitor.jsx b/src/components/services/site-monitor.jsx
index 3d5ef79e1..4dceb44ce 100644
--- a/src/components/services/site-monitor.jsx
+++ b/src/components/services/site-monitor.jsx
@@ -1,9 +1,9 @@
import { useTranslation } from "react-i18next";
import useSWR from "swr";
-export default function SiteMonitor({ group, service, style }) {
+export default function SiteMonitor({ groupName, serviceName, style }) {
const { t } = useTranslation();
- const { data, error } = useSWR(`/api/siteMonitor?${new URLSearchParams({ group, service }).toString()}`, {
+ const { data, error } = useSWR(`/api/siteMonitor?${new URLSearchParams({ groupName, serviceName }).toString()}`, {
refreshInterval: 30000,
});
diff --git a/src/pages/api/ping.js b/src/pages/api/ping.js
index e540fa688..8ef64ffc9 100644
--- a/src/pages/api/ping.js
+++ b/src/pages/api/ping.js
@@ -6,10 +6,10 @@ import createLogger from "utils/logger";
const logger = createLogger("ping");
export default async function handler(req, res) {
- const { group, service } = req.query;
- const serviceItem = await getServiceItem(group, service);
+ const { groupName, serviceName } = req.query;
+ const serviceItem = await getServiceItem(groupName, serviceName);
if (!serviceItem) {
- logger.debug(`No service item found for group ${group} named ${service}`);
+ logger.debug(`No service item found for group ${groupName} named ${serviceName}`);
return res.status(400).send({
error: "Unable to find service, see log for details.",
});
diff --git a/src/pages/api/siteMonitor.js b/src/pages/api/siteMonitor.js
index 9e030d743..072d3d4c6 100644
--- a/src/pages/api/siteMonitor.js
+++ b/src/pages/api/siteMonitor.js
@@ -7,10 +7,10 @@ import { httpProxy } from "utils/proxy/http";
const logger = createLogger("siteMonitor");
export default async function handler(req, res) {
- const { group, service } = req.query;
- const serviceItem = await getServiceItem(group, service);
+ const { groupName, serviceName } = req.query;
+ const serviceItem = await getServiceItem(groupName, serviceName);
if (!serviceItem) {
- logger.debug(`No service item found for group ${group} named ${service}`);
+ logger.debug(`No service item found for group ${groupName} named ${serviceName}`);
return res.status(400).send({
error: "Unable to find service, see log for details.",
});
diff --git a/src/pages/index.jsx b/src/pages/index.jsx
index dd0df95ff..7a7fdef05 100644
--- a/src/pages/index.jsx
+++ b/src/pages/index.jsx
@@ -291,8 +291,7 @@ function Home({ initialSettings }) {
group.services ? (
- +
-
- -+ {iconOnly ? ( +{bookmark.icon && ( -+-)} {!bookmark.icon && bookmark.abbr}-@@ -350,6 +352,7 @@ function Home({ initialSettings }) { settings.useEqualHeights, settings.cardBlur, settings.groupsInitiallyCollapsed, + settings.bookmarksStyle, initialSettings.layout, ]); From 27f536c2677c1eddeef15fc4bcb8593bd7e64e0e Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 10 Dec 2024 08:30:31 -0800 Subject: [PATCH 18/43] Fix: evcc docs name --- docs/widgets/services/evcc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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]`. From 01252c619388bd9e8d29cc481f70abb1d9d9e5a2 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 10 Dec 2024 08:36:32 -0800 Subject: [PATCH 19/43] Fix: correct evcc units (#4396) --- public/locales/en/common.json | 2 +- src/widgets/evcc/component.jsx | 21 ++++++++------------- 2 files changed, 9 insertions(+), 14 deletions(-) diff --git a/public/locales/en/common.json b/public/locales/en/common.json index 484f76b5c..e3670e806 100644 --- a/public/locales/en/common.json +++ b/public/locales/en/common.json @@ -120,7 +120,7 @@ "grid_power": "Grid", "home_power": "Consumption", "charge_power": "Charger", - "watt_hour": "Wh" + "kilowatt": "kW" }, "flood": { "download": "Download", diff --git a/src/widgets/evcc/component.jsx b/src/widgets/evcc/component.jsx index 9f5d4c4d5..09a8ffe4f 100644 --- a/src/widgets/evcc/component.jsx +++ b/src/widgets/evcc/component.jsx @@ -4,6 +4,10 @@ import Container from "components/services/widget/container"; import Block from "components/services/widget/block"; import useWidgetAPI from "utils/proxy/use-widget-api"; +function toKilowatts(t, value) { + return value > 0 ? t("common.number", { value: value / 1000, maximumFractionDigits: 1 }) : 0; +} + export default function Component({ service }) { const { t } = useTranslation(); @@ -27,21 +31,12 @@ export default function Component({ service }) { return ({bookmark.name}-- {description} + ) : ( ++ )} ); diff --git a/src/components/bookmarks/list.jsx b/src/components/bookmarks/list.jsx index 521ca7fb9..194bb43af 100644 --- a/src/components/bookmarks/list.jsx +++ b/src/components/bookmarks/list.jsx @@ -4,16 +4,22 @@ import { columnMap } from "../../utils/layout/columns"; import Item from "components/bookmarks/item"; -export default function List({ bookmarks, layout }) { +export default function List({ bookmarks, layout, bookmarksStyle }) { + let classes = + layout?.style === "row" ? `grid ${columnMap[layout?.columns]} gap-x-2` : "flex flex-col mt-3 bookmark-list"; + const style = {}; + if (layout?.iconsOnly || bookmarksStyle === "icons") { + classes = "grid gap-3 mt-3 bookmark-list"; + style.gridTemplateColumns = "repeat(auto-fill, minmax(60px, 1fr))"; + } return ( -+-+ {bookmark.icon && ( ++++ )} + {!bookmark.icon && bookmark.abbr} +
+ +{bookmark.name}++ {description} +-
+
- +
- ))}
-
{bookmarks.map((bookmark) => (
-
))} - ); From 3c28e4af44e1656d3acb3b6453072243a6ba6eb6 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 12 Dec 2024 15:42:06 -0800 Subject: [PATCH 20/43] Fix empty groups with configured services --- src/utils/config/api-response.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utils/config/api-response.js b/src/utils/config/api-response.js index 5f40d6263..01bef3a13 100644 --- a/src/utils/config/api-response.js +++ b/src/utils/config/api-response.js @@ -158,7 +158,7 @@ export async function servicesResponse() { const discoveredKubernetesGroup = findGroupByName(discoveredKubernetesServices, groupName) || { services: [], }; - const configuredGroup = findGroupByName(configuredServices, groupName) || { services: [] }; + const configuredGroup = findGroupByName(configuredServices, groupName) || { services: [], groups: [] }; const mergedGroup = { name: groupName, From 22c02f4e45552d5857739efe32f8653f4f37d812 Mon Sep 17 00:00:00 2001 From: Mindfreak9100- - + + + - + <> +- - - - + + {widget?.enableLeechProgress && + leechTorrents.map((queueEntry) => ( ++ + + + + ))} + ); } From 5bc67137f6cb37ec7ed3d21da83d0bcdbcfbd03b Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 12 Dec 2024 20:53:20 -0800 Subject: [PATCH 22/43] Fix: glances metric - different key for process list memory on windows host (#4410) --- src/widgets/glances/metrics/process.jsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/widgets/glances/metrics/process.jsx b/src/widgets/glances/metrics/process.jsx index b997a5689..b20b4c634 100644 --- a/src/widgets/glances/metrics/process.jsx +++ b/src/widgets/glances/metrics/process.jsx @@ -63,7 +63,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, })}From 20445583cd19542cee1bbbbb21d2ca3c9e28d564 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 13 Dec 2024 10:59:44 -0800 Subject: [PATCH 23/43] Build feature images --- .github/workflows/docker-publish.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index 2ac8b3e8a..006087051 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -118,7 +118,7 @@ jobs: uses: docker/build-push-action@v6 with: context: . - push: ${{ github.event_name != 'pull_request' && !(github.event_name == 'push' && startsWith(github.ref, 'refs/heads/feature')) }} + push: ${{ github.event_name != 'pull_request' }} tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} build-args: | From 48e0a0e8efdb1b822c6d48ac1d4774947120cdeb Mon Sep 17 00:00:00 2001 From: Epoch Philosophy <35877292+epoch-philosophy@users.noreply.github.com> Date: Fri, 13 Dec 2024 14:03:32 -0600 Subject: [PATCH 24/43] Documentation: update k8s.md to Reflect New Traefik V3 API (#4416) --- docs/installation/k8s.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/k8s.md b/docs/installation/k8s.md index 24be2c341..cf0ec3c62 100644 --- a/docs/installation/k8s.md +++ b/docs/installation/k8s.md @@ -210,7 +210,7 @@ rules: - get - list - apiGroups: - - traefik.containo.us + - traefik.io resources: - ingressroutes verbs: From 191a95c55c6546e69fb0a18350a6fb33276ba3bd Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 14 Dec 2024 15:51:52 -0800 Subject: [PATCH 25/43] Fix: maybe prevent unnecessary search suggestion calls --- src/components/quicklaunch.jsx | 2 +- src/components/widgets/search/search.jsx | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/src/components/quicklaunch.jsx b/src/components/quicklaunch.jsx index 9f55f973c..cf2ed813a 100644 --- a/src/components/quicklaunch.jsx +++ b/src/components/quicklaunch.jsx @@ -129,7 +129,7 @@ export default function QuickLaunch({ servicesAndBookmarks, searchString, setSea useEffect(() => { const abortController = new AbortController(); - if (searchString.length === 0) setResults([]); + if (searchString.trim().length === 0) setResults([]); else { let newResults = servicesAndBookmarks.filter((r) => { const nameMatch = r.name.toLowerCase().includes(searchString); diff --git a/src/components/widgets/search/search.jsx b/src/components/widgets/search/search.jsx index c9391d355..5a7edc04b 100644 --- a/src/components/widgets/search/search.jsx +++ b/src/components/widgets/search/search.jsx @@ -94,6 +94,7 @@ export default function Search({ options }) { if ( options.showSearchSuggestions && (selectedProvider.suggestionUrl || options.suggestionUrl) && // custom providers pass url via options + query.trim().length > 0 && query.trim() !== searchSuggestions[0] ) { fetch(`/api/search/searchSuggestion?query=${encodeURIComponent(query)}&providerName=${selectedProvider.name}`, { From 29928a9a5ffc3dc2790f890a89576f520e2e3151 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 14 Dec 2024 22:57:36 -0800 Subject: [PATCH 26/43] Update requirement --- docs/widgets/authoring/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/widgets/authoring/getting-started.md b/docs/widgets/authoring/getting-started.md index 4b9126ea7..dd33c21ef 100644 --- a/docs/widgets/authoring/getting-started.md +++ b/docs/widgets/authoring/getting-started.md @@ -55,7 +55,7 @@ self-hosted / open-source alternative, we ask that any widgets, etc. are develop 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 From a35c60f9736c4b20c96a34d51f904d9010051b35 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 14 Dec 2024 22:59:56 -0800 Subject: [PATCH 27/43] Update repo-maintenance.yml --- .github/workflows/repo-maintenance.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/repo-maintenance.yml b/.github/workflows/repo-maintenance.yml index 7cf47c51b..02f33b99a 100644 --- a/.github/workflows/repo-maintenance.yml +++ b/.github/workflows/repo-maintenance.yml @@ -212,9 +212,9 @@ jobs: } const CUTOFF_1_DAYS = 180; - const CUTOFF_1_COUNT = 5; + const CUTOFF_1_COUNT = 10; const CUTOFF_2_DAYS = 365; - const CUTOFF_2_COUNT = 10; + const CUTOFF_2_COUNT = 20; const cutoff1Date = new Date(); cutoff1Date.setDate(cutoff1Date.getDate() - CUTOFF_1_DAYS); From deff2f5506e39c73ef492280b6b4201c322de010 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sun, 15 Dec 2024 15:24:31 -0800 Subject: [PATCH 28/43] Maybe this will make the requirements more obvious --- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1d9e6243b..ba5935238 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,14 @@ + + ## Proposed change
{getInnerBlock(children)}
{getBottomBlock(children)}
From 6d829bce7993795ecaa7c89206afb904948f4cb5 Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Wed, 27 Nov 2024 22:12:59 -0800
Subject: [PATCH 08/43] Enhancement: use css color-scheme (#4349)
---
src/pages/index.jsx | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/src/pages/index.jsx b/src/pages/index.jsx
index 7a7fdef05..3f8ebf86d 100644
--- a/src/pages/index.jsx
+++ b/src/pages/index.jsx
@@ -452,6 +452,7 @@ function Home({ initialSettings }) {
}
export default function Wrapper({ initialSettings, fallback }) {
+ const { theme } = useContext(ThemeContext);
const wrappedStyle = {};
let backgroundBlur = false;
let backgroundSaturate = false;
@@ -482,8 +483,9 @@ export default function Wrapper({ initialSettings, fallback }) {
id="page_wrapper"
className={classNames(
"relative",
- initialSettings.theme && initialSettings.theme,
+ theme && theme,
initialSettings.color && `theme-${initialSettings.color}`,
+ theme === "dark" ? "scheme-dark" : "scheme-light",
)}
>
Date: Wed, 27 Nov 2024 22:49:14 -0800
Subject: [PATCH 09/43] Documentation: doc updates for nesting, reorganizing,
fixes
---
docs/configs/info-widgets.md | 24 +++++++++++
docs/configs/service-widgets.md | 58 -------------------------
docs/configs/services.md | 71 +++++++++++++++++++++++++++++++
docs/configs/settings.md | 29 +++++++++++--
docs/troubleshooting/index.md | 2 +-
docs/widgets/authoring/proxies.md | 2 +-
docs/widgets/index.md | 4 ++
docs/widgets/info/openmeteo.md | 2 +-
docs/widgets/info/weather.md | 22 ----------
mkdocs.yml | 4 +-
src/skeleton/services.yaml | 2 +-
src/skeleton/settings.yaml | 2 +-
src/skeleton/widgets.yaml | 2 +-
13 files changed, 132 insertions(+), 92 deletions(-)
create mode 100644 docs/configs/info-widgets.md
delete mode 100644 docs/configs/service-widgets.md
delete mode 100644 docs/widgets/info/weather.md
diff --git a/docs/configs/info-widgets.md b/docs/configs/info-widgets.md
new file mode 100644
index 000000000..763143960
--- /dev/null
+++ b/docs/configs/info-widgets.md
@@ -0,0 +1,24 @@
+---
+title: Information Widgets
+description: Homepage info widgets.
+---
+
+Information widgets are widgets that provide information about your system or environment and are displayed at the top of the homepage. You can find a list of all available info widgets under the [Info Widgets](../widgets/info/index.md) section.
+
+Info widgets are defined in the widgets.yaml
+
+Each widget has its own configuration options, which are detailed in the widget's documentation.
+
+## Layout
+
+Info widgets are displayed in the order they are defined in the `widgets.yaml` file. You can change the order by moving the widgets around in the file. However, some widgets (weather, search and datetime) are aligned to the right side of the screen which can affect the layout of the widgets.
+
+## Adding A Link
+
+You can add a link to an info widget such as the logo or text widgets by adding an `href` option, for example:
+
+```yaml
+logo:
+ href: https://example.com
+ target: _blank # Optional, can be set in settings
+```
diff --git a/docs/configs/service-widgets.md b/docs/configs/service-widgets.md
deleted file mode 100644
index df696f618..000000000
--- a/docs/configs/service-widgets.md
+++ /dev/null
@@ -1,58 +0,0 @@
----
-title: Service Widgets
-description: Service Widget Configuration
----
-
-Unless otherwise noted, URLs should not end with a `/` or other API path. Each widget will handle the path on its own.
-
-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
-```
diff --git a/docs/configs/services.md b/docs/configs/services.md
index 9cb75177e..6ef25c39f 100644
--- a/docs/configs/services.md
+++ b/docs/configs/services.md
@@ -21,6 +21,23 @@ Groups are defined as top-level array entries.
+### 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,
diff --git a/docs/configs/settings.md b/docs/configs/settings.md
index 2f387a65b..7e1815bb1 100644
--- a/docs/configs/settings.md
+++ b/docs/configs/settings.md
@@ -137,6 +137,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 +369,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 +384,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/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/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 4bd45af71..fbb8edc63 100644
--- a/docs/widgets/index.md
+++ b/docs/widgets/index.md
@@ -28,6 +28,8 @@ Service widgets are used to display the status of a service, often a web service
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:
@@ -39,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/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/mkdocs.yml b/mkdocs.yml
index a19d3b839..fa2188ad5 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -21,8 +21,8 @@ nav:
- configs/index.md
- configs/settings.md
- configs/bookmarks.md
+ - configs/info-widgets.md
- configs/services.md
- - configs/service-widgets.md
- configs/kubernetes.md
- configs/docker.md
- configs/custom-css-js.md
@@ -142,6 +142,7 @@ nav:
- widgets/services/spoolman.md
- widgets/services/stash.md
- widgets/services/stocks.md
+ - widgets/services/suwayomi.md
- widgets/services/swagdashboard.md
- widgets/services/syncthing-relay-server.md
- widgets/services/tailscale.md
@@ -177,7 +178,6 @@ nav:
- widgets/info/search.md
- widgets/info/stocks.md
- widgets/info/unifi_controller.md
- - widgets/info/weather.md
- "Learn":
- widgets/authoring/index.md
- "Getting Started": widgets/authoring/getting-started.md
diff --git a/src/skeleton/services.yaml b/src/skeleton/services.yaml
index 77626b1c8..39b379263 100644
--- a/src/skeleton/services.yaml
+++ b/src/skeleton/services.yaml
@@ -1,6 +1,6 @@
---
# For configuration options and examples, please see:
-# https://gethomepage.dev/configs/services
+# https://gethomepage.dev/configs/services/
- My First Group:
- My First Service:
diff --git a/src/skeleton/settings.yaml b/src/skeleton/settings.yaml
index 141053f5b..2e828c082 100644
--- a/src/skeleton/settings.yaml
+++ b/src/skeleton/settings.yaml
@@ -1,6 +1,6 @@
---
# For configuration options and examples, please see:
-# https://gethomepage.dev/configs/settings
+# https://gethomepage.dev/configs/settings/
providers:
openweathermap: openweathermapapikey
diff --git a/src/skeleton/widgets.yaml b/src/skeleton/widgets.yaml
index 23c8d6136..b1cf0f558 100644
--- a/src/skeleton/widgets.yaml
+++ b/src/skeleton/widgets.yaml
@@ -1,6 +1,6 @@
---
# For configuration options and examples, please see:
-# https://gethomepage.dev/configs/service-widgets
+# https://gethomepage.dev/configs/info-widgets/
- resources:
cpu: true
From 5cc487a96ddd6327d2d7a0d6acfabc3d5f960e59 Mon Sep 17 00:00:00 2001
From: zombaru <16330202+zombaru@users.noreply.github.com>
Date: Thu, 28 Nov 2024 20:15:28 -0800
Subject: [PATCH 10/43] Documentation: Add missing admonition type to UniFi
docs (#4353)
---
docs/widgets/info/unifi_controller.md | 2 +-
docs/widgets/services/unifi-controller.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
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/services/unifi-controller.md b/docs/widgets/services/unifi-controller.md
index d137c2a95..c5efc688e 100644
--- a/docs/widgets/services/unifi-controller.md
+++ b/docs/widgets/services/unifi-controller.md
@@ -9,7 +9,7 @@ _(Find the Unifi Controller information widget [here](../info/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.
From 276a1c3ef423f7b027a84ad5c8ac7ef30d04ca2f Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Thu, 28 Nov 2024 21:54:22 -0800
Subject: [PATCH 11/43] Chore: better tailscale error handling
---
src/widgets/tailscale/component.jsx | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
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 `: Network data usage for the specified interface. Replace `` with the name of your network interface, e.g., `network:enp0s25`, as specified in glances.
`sensor:`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `` with the name of your sensor, e.g., `sensor:Package id 0` as specified in glances.
diff --git a/src/widgets/glances/component.jsx b/src/widgets/glances/component.jsx
index df916b4ba..bff31ac16 100644
--- a/src/widgets/glances/component.jsx
+++ b/src/widgets/glances/component.jsx
@@ -7,6 +7,7 @@ import Disk from "./metrics/disk";
import GPU from "./metrics/gpu";
import Info from "./metrics/info";
import Fs from "./metrics/fs";
+import Containers from "./metrics/containers";
export default function Component({ service }) {
const { widget } = service;
@@ -23,6 +24,10 @@ export default function Component({ service }) {
return
+ -
+
+ );
+ }
+
+ data.splice(chart ? 5 : 1);
+
+ return (
+
+
+
+
+
+
+
+ );
+}
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;
From 20df9a5e9ce685621c02f68a657056a4a5d569f3 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Sun, 1 Dec 2024 08:56:52 -0800
Subject: [PATCH 14/43] Chore(deps): Bump gamedig from 5.1.3 to 5.1.4 (#4369)
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
package-lock.json | 9 ++++-----
package.json | 2 +-
pnpm-lock.yaml | 27 +++++++++++++--------------
3 files changed, 18 insertions(+), 20 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index 14b7d054a..af3ab5b76 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -15,7 +15,7 @@
"compare-versions": "^6.1.0",
"dockerode": "^4.0.2",
"follow-redirects": "^1.15.9",
- "gamedig": "^5.1.2",
+ "gamedig": "^5.1.4",
"i18next": "^21.10.0",
"js-yaml": "^4.1.0",
"json-rpc-2.0": "^1.7.0",
@@ -3847,9 +3847,9 @@
}
},
"node_modules/gamedig": {
- "version": "5.1.3",
- "resolved": "https://registry.npmjs.org/gamedig/-/gamedig-5.1.3.tgz",
- "integrity": "sha512-ECksJC4idM3a+P+a+j9/XHcPOsP4DUrwowK38QucDQ4x5T7mQDWErY2n8NE4kV4HKjCq16ifNMAEt+/nyCKWog==",
+ "version": "5.1.4",
+ "resolved": "https://registry.npmjs.org/gamedig/-/gamedig-5.1.4.tgz",
+ "integrity": "sha512-MgSbNVGh5QMdrmRTrZ3W7W6sC5/Mx+dMgTy2uZCKQ9vns9eFXkQj61Pw2Y2FNHNMMp4DXFSUMYAPJWLcR16Wwg==",
"license": "MIT",
"dependencies": {
"cheerio": "1.0.0-rc.12",
@@ -3858,7 +3858,6 @@
"iconv-lite": "0.6.3",
"long": "5.2.3",
"minimist": "1.2.8",
- "punycode": "2.3.1",
"seek-bzip": "2.0.0",
"varint": "6.0.0"
},
diff --git a/package.json b/package.json
index 8be8d3623..b9ac26d86 100644
--- a/package.json
+++ b/package.json
@@ -17,7 +17,7 @@
"compare-versions": "^6.1.0",
"dockerode": "^4.0.2",
"follow-redirects": "^1.15.9",
- "gamedig": "^5.1.2",
+ "gamedig": "^5.1.4",
"i18next": "^21.10.0",
"js-yaml": "^4.1.0",
"json-rpc-2.0": "^1.7.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index d73d36c6f..d33a27fc2 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -30,8 +30,8 @@ importers:
specifier: ^1.15.9
version: 1.15.9
gamedig:
- specifier: ^5.1.2
- version: 5.1.3
+ specifier: ^5.1.4
+ version: 5.1.4
i18next:
specifier: ^21.10.0
version: 21.10.0
@@ -117,7 +117,7 @@ importers:
version: 8.57.1
eslint-config-airbnb:
specifier: ^19.0.4
- version: 19.0.4(eslint-plugin-import@2.31.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint@8.57.1))(eslint-plugin-jsx-a11y@6.10.0(eslint@8.57.1))(eslint-plugin-react-hooks@4.6.2(eslint@8.57.1))(eslint-plugin-react@7.37.1(eslint@8.57.1))(eslint@8.57.1)
+ version: 19.0.4(eslint-plugin-import@2.31.0)(eslint-plugin-jsx-a11y@6.10.0(eslint@8.57.1))(eslint-plugin-react-hooks@4.6.2(eslint@8.57.1))(eslint-plugin-react@7.37.1(eslint@8.57.1))(eslint@8.57.1)
eslint-config-next:
specifier: ^14.2.3
version: 14.2.8(eslint@8.57.1)(typescript@5.6.3)
@@ -1316,8 +1316,8 @@ packages:
functions-have-names@1.2.3:
resolution: {integrity: sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==}
- gamedig@5.1.3:
- resolution: {integrity: sha512-ECksJC4idM3a+P+a+j9/XHcPOsP4DUrwowK38QucDQ4x5T7mQDWErY2n8NE4kV4HKjCq16ifNMAEt+/nyCKWog==}
+ gamedig@5.1.4:
+ resolution: {integrity: sha512-MgSbNVGh5QMdrmRTrZ3W7W6sC5/Mx+dMgTy2uZCKQ9vns9eFXkQj61Pw2Y2FNHNMMp4DXFSUMYAPJWLcR16Wwg==}
engines: {node: '>=16.20.0'}
hasBin: true
@@ -3781,7 +3781,7 @@ snapshots:
escape-string-regexp@4.0.0: {}
- eslint-config-airbnb-base@15.0.0(eslint-plugin-import@2.31.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint@8.57.1))(eslint@8.57.1):
+ eslint-config-airbnb-base@15.0.0(eslint-plugin-import@2.31.0)(eslint@8.57.1):
dependencies:
confusing-browser-globals: 1.0.11
eslint: 8.57.1
@@ -3790,10 +3790,10 @@ snapshots:
object.entries: 1.1.8
semver: 6.3.1
- eslint-config-airbnb@19.0.4(eslint-plugin-import@2.31.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint@8.57.1))(eslint-plugin-jsx-a11y@6.10.0(eslint@8.57.1))(eslint-plugin-react-hooks@4.6.2(eslint@8.57.1))(eslint-plugin-react@7.37.1(eslint@8.57.1))(eslint@8.57.1):
+ eslint-config-airbnb@19.0.4(eslint-plugin-import@2.31.0)(eslint-plugin-jsx-a11y@6.10.0(eslint@8.57.1))(eslint-plugin-react-hooks@4.6.2(eslint@8.57.1))(eslint-plugin-react@7.37.1(eslint@8.57.1))(eslint@8.57.1):
dependencies:
eslint: 8.57.1
- eslint-config-airbnb-base: 15.0.0(eslint-plugin-import@2.31.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint@8.57.1))(eslint@8.57.1)
+ eslint-config-airbnb-base: 15.0.0(eslint-plugin-import@2.31.0)(eslint@8.57.1)
eslint-plugin-import: 2.31.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.1)
eslint-plugin-jsx-a11y: 6.10.0(eslint@8.57.1)
eslint-plugin-react: 7.37.1(eslint@8.57.1)
@@ -3839,7 +3839,7 @@ snapshots:
debug: 4.3.6
enhanced-resolve: 5.17.1
eslint: 8.57.1
- eslint-module-utils: 2.9.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.31.0)(eslint@8.57.1))(eslint@8.57.1)
+ eslint-module-utils: 2.9.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.1)
fast-glob: 3.3.2
get-tsconfig: 4.8.0
is-bun-module: 1.1.0
@@ -3852,7 +3852,7 @@ snapshots:
- eslint-import-resolver-webpack
- supports-color
- eslint-module-utils@2.12.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.31.0)(eslint@8.57.1))(eslint@8.57.1):
+ eslint-module-utils@2.12.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.1):
dependencies:
debug: 3.2.7
optionalDependencies:
@@ -3863,7 +3863,7 @@ snapshots:
transitivePeerDependencies:
- supports-color
- eslint-module-utils@2.9.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.31.0)(eslint@8.57.1))(eslint@8.57.1):
+ eslint-module-utils@2.9.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.1):
dependencies:
debug: 3.2.7
optionalDependencies:
@@ -3885,7 +3885,7 @@ snapshots:
doctrine: 2.1.0
eslint: 8.57.1
eslint-import-resolver-node: 0.3.9
- eslint-module-utils: 2.12.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.31.0)(eslint@8.57.1))(eslint@8.57.1)
+ eslint-module-utils: 2.12.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.1)
hasown: 2.0.2
is-core-module: 2.15.1
is-glob: 4.0.3
@@ -4138,7 +4138,7 @@ snapshots:
functions-have-names@1.2.3: {}
- gamedig@5.1.3:
+ gamedig@5.1.4:
dependencies:
cheerio: 1.0.0-rc.12
gbxremote: 0.2.1
@@ -4146,7 +4146,6 @@ snapshots:
iconv-lite: 0.6.3
long: 5.2.3
minimist: 1.2.8
- punycode: 2.3.1
seek-bzip: 2.0.0
varint: 6.0.0
From 8cc6640d046feef0d4015c935d83a220cc992d12 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Sun, 1 Dec 2024 09:02:09 -0800
Subject: [PATCH 15/43] Chore(deps-dev): Bump eslint-plugin-react from 7.37.1
to 7.37.2 (#4367)
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
package-lock.json | 91 ++++++++++++++++++++++++++---------------------
package.json | 2 +-
pnpm-lock.yaml | 54 ++++++++++++++++++++++------
3 files changed, 95 insertions(+), 52 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index af3ab5b76..68a950be7 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -50,7 +50,7 @@
"eslint-plugin-import": "^2.31.0",
"eslint-plugin-jsx-a11y": "^6.8.0",
"eslint-plugin-prettier": "^5.2.1",
- "eslint-plugin-react": "^7.37.1",
+ "eslint-plugin-react": "^7.37.2",
"eslint-plugin-react-hooks": "^4.6.2",
"postcss": "^8.4.47",
"prettier": "^3.2.5",
@@ -2729,9 +2729,9 @@
}
},
"node_modules/es-abstract": {
- "version": "1.23.3",
- "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz",
- "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==",
+ "version": "1.23.5",
+ "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.5.tgz",
+ "integrity": "sha512-vlmniQ0WNPwXqA0BnmwV3Ng7HxiGlh6r5U6JcTMNx8OilcAGqVJBHJcPjqOMaczU9fRuRK5Px2BdVyPRnKMMVQ==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -2750,7 +2750,7 @@
"function.prototype.name": "^1.1.6",
"get-intrinsic": "^1.2.4",
"get-symbol-description": "^1.0.2",
- "globalthis": "^1.0.3",
+ "globalthis": "^1.0.4",
"gopd": "^1.0.1",
"has-property-descriptors": "^1.0.2",
"has-proto": "^1.0.3",
@@ -2766,10 +2766,10 @@
"is-string": "^1.0.7",
"is-typed-array": "^1.1.13",
"is-weakref": "^1.0.2",
- "object-inspect": "^1.13.1",
+ "object-inspect": "^1.13.3",
"object-keys": "^1.1.1",
"object.assign": "^4.1.5",
- "regexp.prototype.flags": "^1.5.2",
+ "regexp.prototype.flags": "^1.5.3",
"safe-array-concat": "^1.1.2",
"safe-regex-test": "^1.0.3",
"string.prototype.trim": "^1.2.9",
@@ -2834,9 +2834,9 @@
}
},
"node_modules/es-iterator-helpers": {
- "version": "1.0.19",
- "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.0.19.tgz",
- "integrity": "sha512-zoMwbCcH5hwUkKJkT8kDIBZSz9I6mVG//+lDCinLCGov4+r7NIy0ld8o03M0cJxl2spVf6ESYVS6/gpIfq1FFw==",
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.2.0.tgz",
+ "integrity": "sha512-tpxqxncxnpw3c93u8n3VOzACmRFoVmWJqbWXvX/JfKbkhBw1oslgPrUfeSt2psuqyEJFD6N/9lg5i7bsKpoq+Q==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -2847,12 +2847,13 @@
"es-set-tostringtag": "^2.0.3",
"function-bind": "^1.1.2",
"get-intrinsic": "^1.2.4",
- "globalthis": "^1.0.3",
+ "globalthis": "^1.0.4",
+ "gopd": "^1.0.1",
"has-property-descriptors": "^1.0.2",
"has-proto": "^1.0.3",
"has-symbols": "^1.0.3",
"internal-slot": "^1.0.7",
- "iterator.prototype": "^1.1.2",
+ "iterator.prototype": "^1.1.3",
"safe-array-concat": "^1.1.2"
},
"engines": {
@@ -3280,17 +3281,18 @@
}
},
"node_modules/eslint-plugin-react": {
- "version": "7.37.1",
- "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.37.1.tgz",
- "integrity": "sha512-xwTnwDqzbDRA8uJ7BMxPs/EXRB3i8ZfnOIp8BsxEQkT0nHPp+WWceqGgo6rKb9ctNi8GJLDT4Go5HAWELa/WMg==",
+ "version": "7.37.2",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.37.2.tgz",
+ "integrity": "sha512-EsTAnj9fLVr/GZleBLFbj/sSuXeWmp1eXIN60ceYnZveqEaUCyW4X+Vh4WTdUhCkW4xutXYqTXCUSyqD4rB75w==",
"dev": true,
+ "license": "MIT",
"dependencies": {
"array-includes": "^3.1.8",
"array.prototype.findlast": "^1.2.5",
"array.prototype.flatmap": "^1.3.2",
"array.prototype.tosorted": "^1.1.4",
"doctrine": "^2.1.0",
- "es-iterator-helpers": "^1.0.19",
+ "es-iterator-helpers": "^1.1.0",
"estraverse": "^5.3.0",
"hasown": "^2.0.2",
"jsx-ast-utils": "^2.4.1 || ^3.0.0",
@@ -4676,13 +4678,16 @@
}
},
"node_modules/is-finalizationregistry": {
- "version": "1.0.2",
- "resolved": "https://registry.npmjs.org/is-finalizationregistry/-/is-finalizationregistry-1.0.2.tgz",
- "integrity": "sha512-0by5vtUJs8iFQb5TYUHHPudOR+qXYIMKtiUzvLIZITZUjknFmziyBJuLhVRc+Ds0dREFlskDNJKYIdIzu/9pfw==",
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/is-finalizationregistry/-/is-finalizationregistry-1.1.0.tgz",
+ "integrity": "sha512-qfMdqbAQEwBw78ZyReKnlA8ezmPdb9BemzIIip/JkjaZUhitfXDkkr+3QTboW0JrSXT1QWyYShpvnNHGZ4c4yA==",
"dev": true,
"license": "MIT",
"dependencies": {
- "call-bind": "^1.0.2"
+ "call-bind": "^1.0.7"
+ },
+ "engines": {
+ "node": ">= 0.4"
},
"funding": {
"url": "https://github.com/sponsors/ljharb"
@@ -4973,9 +4978,9 @@
"license": "MIT"
},
"node_modules/iterator.prototype": {
- "version": "1.1.2",
- "resolved": "https://registry.npmjs.org/iterator.prototype/-/iterator.prototype-1.1.2.tgz",
- "integrity": "sha512-DR33HMMr8EzwuRL8Y9D3u2BMj8+RqSE850jfGu59kS7tbmPLzGkZmVSfyCFSDxuZiEY6Rzt3T2NA/qU+NwVj1w==",
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/iterator.prototype/-/iterator.prototype-1.1.3.tgz",
+ "integrity": "sha512-FW5iMbeQ6rBGm/oKgzq2aW4KvAGpxPzYES8N4g4xNXUKpL1mclMvOe+76AcLDTvD+Ze+sOpVhgdAQEKF4L9iGQ==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -4984,6 +4989,9 @@
"has-symbols": "^1.0.3",
"reflect.getprototypeof": "^1.0.4",
"set-function-name": "^2.0.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
}
},
"node_modules/jackspeak": {
@@ -5757,9 +5765,9 @@
}
},
"node_modules/object-inspect": {
- "version": "1.13.2",
- "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.2.tgz",
- "integrity": "sha512-IRZSRuzJiynemAXPYtPe5BoI/RESNYR7TYm50MC5Mqbd3Jmw5y790sErYw3V6SryFJD64b74qQQs9wn5Bg/k3g==",
+ "version": "1.13.3",
+ "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.3.tgz",
+ "integrity": "sha512-kDCGIbxkDSXE3euJZZXzc6to7fCrKHNI/hSRQnRuQ+BWjFNzZwiFF8fj/6o2t2G9/jTj8PSIYTfCLelLZEeRpA==",
"dev": true,
"license": "MIT",
"engines": {
@@ -6676,19 +6684,19 @@
}
},
"node_modules/reflect.getprototypeof": {
- "version": "1.0.6",
- "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.6.tgz",
- "integrity": "sha512-fmfw4XgoDke3kdI6h4xcUz1dG8uaiv5q9gcEwLS4Pnth2kxT+GZ7YehS1JTMGBQmtV7Y4GFGbs2re2NqhdozUg==",
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.7.tgz",
+ "integrity": "sha512-bMvFGIUKlc/eSfXNX+aZ+EL95/EgZzuwA0OBPTbZZDEJw/0AkentjMuM1oiRfwHrshqk4RzdgiTg5CcDalXN5g==",
"dev": true,
"license": "MIT",
"dependencies": {
"call-bind": "^1.0.7",
"define-properties": "^1.2.1",
- "es-abstract": "^1.23.1",
+ "es-abstract": "^1.23.5",
"es-errors": "^1.3.0",
"get-intrinsic": "^1.2.4",
- "globalthis": "^1.0.3",
- "which-builtin-type": "^1.1.3"
+ "gopd": "^1.0.1",
+ "which-builtin-type": "^1.1.4"
},
"engines": {
"node": ">= 0.4"
@@ -6704,16 +6712,16 @@
"license": "MIT"
},
"node_modules/regexp.prototype.flags": {
- "version": "1.5.2",
- "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz",
- "integrity": "sha512-NcDiDkTLuPR+++OCKB0nWafEmhg/Da8aUPLPMQbK+bxKKCm1/S5he+AqYa4PlMCVBalb4/yxIRub6qkEx5yJbw==",
+ "version": "1.5.3",
+ "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.3.tgz",
+ "integrity": "sha512-vqlC04+RQoFalODCbCumG2xIOvapzVMHwsyIGM/SIE8fRhFFsXeH8/QQ+s0T0kDAhKc4k30s73/0ydkHQz6HlQ==",
"dev": true,
"license": "MIT",
"dependencies": {
- "call-bind": "^1.0.6",
+ "call-bind": "^1.0.7",
"define-properties": "^1.2.1",
"es-errors": "^1.3.0",
- "set-function-name": "^2.0.1"
+ "set-function-name": "^2.0.2"
},
"engines": {
"node": ">= 0.4"
@@ -8336,17 +8344,18 @@
}
},
"node_modules/which-builtin-type": {
- "version": "1.1.4",
- "resolved": "https://registry.npmjs.org/which-builtin-type/-/which-builtin-type-1.1.4.tgz",
- "integrity": "sha512-bppkmBSsHFmIMSl8BO9TbsyzsvGjVoppt8xUiGzwiu/bhDCGxnpOKCxgqj6GuyHE0mINMDecBFPlOm2hzY084w==",
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/which-builtin-type/-/which-builtin-type-1.2.0.tgz",
+ "integrity": "sha512-I+qLGQ/vucCby4tf5HsLmGueEla4ZhwTBSqaooS+Y0BuxN4Cp+okmGuV+8mXZ84KDI9BA+oklo+RzKg0ONdSUA==",
"dev": true,
"license": "MIT",
"dependencies": {
+ "call-bind": "^1.0.7",
"function.prototype.name": "^1.1.6",
"has-tostringtag": "^1.0.2",
"is-async-function": "^2.0.0",
"is-date-object": "^1.0.5",
- "is-finalizationregistry": "^1.0.2",
+ "is-finalizationregistry": "^1.1.0",
"is-generator-function": "^1.0.10",
"is-regex": "^1.1.4",
"is-weakref": "^1.0.2",
diff --git a/package.json b/package.json
index b9ac26d86..5210b4743 100644
--- a/package.json
+++ b/package.json
@@ -52,7 +52,7 @@
"eslint-plugin-import": "^2.31.0",
"eslint-plugin-jsx-a11y": "^6.8.0",
"eslint-plugin-prettier": "^5.2.1",
- "eslint-plugin-react": "^7.37.1",
+ "eslint-plugin-react": "^7.37.2",
"eslint-plugin-react-hooks": "^4.6.2",
"postcss": "^8.4.47",
"prettier": "^3.2.5",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index d33a27fc2..0321907c2 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -117,7 +117,7 @@ importers:
version: 8.57.1
eslint-config-airbnb:
specifier: ^19.0.4
- version: 19.0.4(eslint-plugin-import@2.31.0)(eslint-plugin-jsx-a11y@6.10.0(eslint@8.57.1))(eslint-plugin-react-hooks@4.6.2(eslint@8.57.1))(eslint-plugin-react@7.37.1(eslint@8.57.1))(eslint@8.57.1)
+ version: 19.0.4(eslint-plugin-import@2.31.0)(eslint-plugin-jsx-a11y@6.10.0(eslint@8.57.1))(eslint-plugin-react-hooks@4.6.2(eslint@8.57.1))(eslint-plugin-react@7.37.2(eslint@8.57.1))(eslint@8.57.1)
eslint-config-next:
specifier: ^14.2.3
version: 14.2.8(eslint@8.57.1)(typescript@5.6.3)
@@ -134,8 +134,8 @@ importers:
specifier: ^5.2.1
version: 5.2.1(eslint-config-prettier@9.1.0(eslint@8.57.1))(eslint@8.57.1)(prettier@3.3.3)
eslint-plugin-react:
- specifier: ^7.37.1
- version: 7.37.1(eslint@8.57.1)
+ specifier: ^7.37.2
+ version: 7.37.2(eslint@8.57.1)
eslint-plugin-react-hooks:
specifier: ^4.6.2
version: 4.6.2(eslint@8.57.1)
@@ -1006,6 +1006,10 @@ packages:
resolution: {integrity: sha512-zoMwbCcH5hwUkKJkT8kDIBZSz9I6mVG//+lDCinLCGov4+r7NIy0ld8o03M0cJxl2spVf6ESYVS6/gpIfq1FFw==}
engines: {node: '>= 0.4'}
+ es-iterator-helpers@1.2.0:
+ resolution: {integrity: sha512-tpxqxncxnpw3c93u8n3VOzACmRFoVmWJqbWXvX/JfKbkhBw1oslgPrUfeSt2psuqyEJFD6N/9lg5i7bsKpoq+Q==}
+ engines: {node: '>= 0.4'}
+
es-object-atoms@1.0.0:
resolution: {integrity: sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==}
engines: {node: '>= 0.4'}
@@ -1155,8 +1159,8 @@ packages:
peerDependencies:
eslint: ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0
- eslint-plugin-react@7.37.1:
- resolution: {integrity: sha512-xwTnwDqzbDRA8uJ7BMxPs/EXRB3i8ZfnOIp8BsxEQkT0nHPp+WWceqGgo6rKb9ctNi8GJLDT4Go5HAWELa/WMg==}
+ eslint-plugin-react@7.37.2:
+ resolution: {integrity: sha512-EsTAnj9fLVr/GZleBLFbj/sSuXeWmp1eXIN60ceYnZveqEaUCyW4X+Vh4WTdUhCkW4xutXYqTXCUSyqD4rB75w==}
engines: {node: '>=4'}
peerDependencies:
eslint: ^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9.7
@@ -1648,6 +1652,10 @@ packages:
iterator.prototype@1.1.2:
resolution: {integrity: sha512-DR33HMMr8EzwuRL8Y9D3u2BMj8+RqSE850jfGu59kS7tbmPLzGkZmVSfyCFSDxuZiEY6Rzt3T2NA/qU+NwVj1w==}
+ iterator.prototype@1.1.3:
+ resolution: {integrity: sha512-FW5iMbeQ6rBGm/oKgzq2aW4KvAGpxPzYES8N4g4xNXUKpL1mclMvOe+76AcLDTvD+Ze+sOpVhgdAQEKF4L9iGQ==}
+ engines: {node: '>= 0.4'}
+
jackspeak@2.3.6:
resolution: {integrity: sha512-N3yCS/NegsOBokc8GAdM8UcmfsKiSS8cipheD/nivzr700H+nsMOxJjQnvwOcRYVuFkdH0wGUvW2WbXGmrZGbQ==}
engines: {node: '>=14'}
@@ -3757,6 +3765,24 @@ snapshots:
iterator.prototype: 1.1.2
safe-array-concat: 1.1.2
+ es-iterator-helpers@1.2.0:
+ dependencies:
+ call-bind: 1.0.7
+ define-properties: 1.2.1
+ es-abstract: 1.23.3
+ es-errors: 1.3.0
+ es-set-tostringtag: 2.0.3
+ function-bind: 1.1.2
+ get-intrinsic: 1.2.4
+ globalthis: 1.0.4
+ gopd: 1.0.1
+ has-property-descriptors: 1.0.2
+ has-proto: 1.0.3
+ has-symbols: 1.0.3
+ internal-slot: 1.0.7
+ iterator.prototype: 1.1.3
+ safe-array-concat: 1.1.2
+
es-object-atoms@1.0.0:
dependencies:
es-errors: 1.3.0
@@ -3790,13 +3816,13 @@ snapshots:
object.entries: 1.1.8
semver: 6.3.1
- eslint-config-airbnb@19.0.4(eslint-plugin-import@2.31.0)(eslint-plugin-jsx-a11y@6.10.0(eslint@8.57.1))(eslint-plugin-react-hooks@4.6.2(eslint@8.57.1))(eslint-plugin-react@7.37.1(eslint@8.57.1))(eslint@8.57.1):
+ eslint-config-airbnb@19.0.4(eslint-plugin-import@2.31.0)(eslint-plugin-jsx-a11y@6.10.0(eslint@8.57.1))(eslint-plugin-react-hooks@4.6.2(eslint@8.57.1))(eslint-plugin-react@7.37.2(eslint@8.57.1))(eslint@8.57.1):
dependencies:
eslint: 8.57.1
eslint-config-airbnb-base: 15.0.0(eslint-plugin-import@2.31.0)(eslint@8.57.1)
eslint-plugin-import: 2.31.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.1)
eslint-plugin-jsx-a11y: 6.10.0(eslint@8.57.1)
- eslint-plugin-react: 7.37.1(eslint@8.57.1)
+ eslint-plugin-react: 7.37.2(eslint@8.57.1)
eslint-plugin-react-hooks: 4.6.2(eslint@8.57.1)
object.assign: 4.1.5
object.entries: 1.1.8
@@ -3812,7 +3838,7 @@ snapshots:
eslint-import-resolver-typescript: 3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.31.0)(eslint@8.57.1)
eslint-plugin-import: 2.31.0(@typescript-eslint/parser@7.2.0(eslint@8.57.1)(typescript@5.6.3))(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.1)
eslint-plugin-jsx-a11y: 6.10.0(eslint@8.57.1)
- eslint-plugin-react: 7.37.1(eslint@8.57.1)
+ eslint-plugin-react: 7.37.2(eslint@8.57.1)
eslint-plugin-react-hooks: 4.6.2(eslint@8.57.1)
optionalDependencies:
typescript: 5.6.3
@@ -3936,14 +3962,14 @@ snapshots:
dependencies:
eslint: 8.57.1
- eslint-plugin-react@7.37.1(eslint@8.57.1):
+ eslint-plugin-react@7.37.2(eslint@8.57.1):
dependencies:
array-includes: 3.1.8
array.prototype.findlast: 1.2.5
array.prototype.flatmap: 1.3.2
array.prototype.tosorted: 1.1.4
doctrine: 2.1.0
- es-iterator-helpers: 1.0.19
+ es-iterator-helpers: 1.2.0
eslint: 8.57.1
estraverse: 5.3.0
hasown: 2.0.2
@@ -4495,6 +4521,14 @@ snapshots:
reflect.getprototypeof: 1.0.6
set-function-name: 2.0.2
+ iterator.prototype@1.1.3:
+ dependencies:
+ define-properties: 1.2.1
+ get-intrinsic: 1.2.4
+ has-symbols: 1.0.3
+ reflect.getprototypeof: 1.0.6
+ set-function-name: 2.0.2
+
jackspeak@2.3.6:
dependencies:
'@isaacs/cliui': 8.0.2
From c58f59c105198fd632625047fb27f0ca32951255 Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Mon, 2 Dec 2024 14:38:55 -0800
Subject: [PATCH 16/43] Fix: add optional chaining for info widgets options
---
src/components/widgets/widget/container.jsx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/components/widgets/widget/container.jsx b/src/components/widgets/widget/container.jsx
index 4a1fdd375..8675adf86 100644
--- a/src/components/widgets/widget/container.jsx
+++ b/src/components/widgets/widget/container.jsx
@@ -60,7 +60,7 @@ export function getBottomBlock(children) {
export default function Container({ children = [], options, additionalClassNames = "" }) {
const { settings } = useContext(SettingsContext);
- return options.href ? (
+ return options?.href ? (
Date: Thu, 5 Dec 2024 15:35:31 -0800
Subject: [PATCH 17/43] Enhancement: icons-only bookmarks style (#4384)
---
docs/configs/settings.md | 16 ++++++++++++
src/components/bookmarks/group.jsx | 10 ++++++--
src/components/bookmarks/item.jsx | 39 +++++++++++++++++++++---------
src/components/bookmarks/list.jsx | 22 +++++++++++------
src/pages/index.jsx | 3 +++
5 files changed, 69 insertions(+), 21 deletions(-)
diff --git a/docs/configs/settings.md b/docs/configs/settings.md
index 7e1815bb1..5fe30874f 100644
--- a/docs/configs/settings.md
+++ b/docs/configs/settings.md
@@ -118,6 +118,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.
diff --git a/src/components/bookmarks/group.jsx b/src/components/bookmarks/group.jsx
index 3a9f8323a..9deb1b6a2 100644
--- a/src/components/bookmarks/group.jsx
+++ b/src/components/bookmarks/group.jsx
@@ -7,7 +7,13 @@ import ErrorBoundary from "components/errorboundry";
import List from "components/bookmarks/list";
import ResolvedIcon from "components/resolvedicon";
-export default function BookmarksGroup({ bookmarks, layout, disableCollapse, groupsInitiallyCollapsed }) {
+export default function BookmarksGroup({
+ bookmarks,
+ layout,
+ disableCollapse,
+ groupsInitiallyCollapsed,
+ bookmarksStyle,
+}) {
const panel = useRef();
useEffect(() => {
@@ -64,7 +70,7 @@ export default function BookmarksGroup({ bookmarks, layout, disableCollapse, gro
>
-
diff --git a/src/components/bookmarks/item.jsx b/src/components/bookmarks/item.jsx
index 690970890..48698cc16 100644
--- a/src/components/bookmarks/item.jsx
+++ b/src/components/bookmarks/item.jsx
@@ -4,12 +4,17 @@ import classNames from "classnames";
import { SettingsContext } from "utils/contexts/settings";
import ResolvedIcon from "components/resolvedicon";
-export default function Item({ bookmark }) {
+export default function Item({ bookmark, iconOnly = false }) {
const description = bookmark.description ?? new URL(bookmark.href).hostname;
const { settings } = useContext(SettingsContext);
return (
-
+### 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,
diff --git a/docs/configs/settings.md b/docs/configs/settings.md
index 2f387a65b..7e1815bb1 100644
--- a/docs/configs/settings.md
+++ b/docs/configs/settings.md
@@ -137,6 +137,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 +369,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 +384,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/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/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 4bd45af71..fbb8edc63 100644
--- a/docs/widgets/index.md
+++ b/docs/widgets/index.md
@@ -28,6 +28,8 @@ Service widgets are used to display the status of a service, often a web service
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:
@@ -39,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/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/mkdocs.yml b/mkdocs.yml
index a19d3b839..fa2188ad5 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -21,8 +21,8 @@ nav:
- configs/index.md
- configs/settings.md
- configs/bookmarks.md
+ - configs/info-widgets.md
- configs/services.md
- - configs/service-widgets.md
- configs/kubernetes.md
- configs/docker.md
- configs/custom-css-js.md
@@ -142,6 +142,7 @@ nav:
- widgets/services/spoolman.md
- widgets/services/stash.md
- widgets/services/stocks.md
+ - widgets/services/suwayomi.md
- widgets/services/swagdashboard.md
- widgets/services/syncthing-relay-server.md
- widgets/services/tailscale.md
@@ -177,7 +178,6 @@ nav:
- widgets/info/search.md
- widgets/info/stocks.md
- widgets/info/unifi_controller.md
- - widgets/info/weather.md
- "Learn":
- widgets/authoring/index.md
- "Getting Started": widgets/authoring/getting-started.md
diff --git a/src/skeleton/services.yaml b/src/skeleton/services.yaml
index 77626b1c8..39b379263 100644
--- a/src/skeleton/services.yaml
+++ b/src/skeleton/services.yaml
@@ -1,6 +1,6 @@
---
# For configuration options and examples, please see:
-# https://gethomepage.dev/configs/services
+# https://gethomepage.dev/configs/services/
- My First Group:
- My First Service:
diff --git a/src/skeleton/settings.yaml b/src/skeleton/settings.yaml
index 141053f5b..2e828c082 100644
--- a/src/skeleton/settings.yaml
+++ b/src/skeleton/settings.yaml
@@ -1,6 +1,6 @@
---
# For configuration options and examples, please see:
-# https://gethomepage.dev/configs/settings
+# https://gethomepage.dev/configs/settings/
providers:
openweathermap: openweathermapapikey
diff --git a/src/skeleton/widgets.yaml b/src/skeleton/widgets.yaml
index 23c8d6136..b1cf0f558 100644
--- a/src/skeleton/widgets.yaml
+++ b/src/skeleton/widgets.yaml
@@ -1,6 +1,6 @@
---
# For configuration options and examples, please see:
-# https://gethomepage.dev/configs/service-widgets
+# https://gethomepage.dev/configs/info-widgets/
- resources:
cpu: true
From 5cc487a96ddd6327d2d7a0d6acfabc3d5f960e59 Mon Sep 17 00:00:00 2001
From: zombaru <16330202+zombaru@users.noreply.github.com>
Date: Thu, 28 Nov 2024 20:15:28 -0800
Subject: [PATCH 10/43] Documentation: Add missing admonition type to UniFi
docs (#4353)
---
docs/widgets/info/unifi_controller.md | 2 +-
docs/widgets/services/unifi-controller.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
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/services/unifi-controller.md b/docs/widgets/services/unifi-controller.md
index d137c2a95..c5efc688e 100644
--- a/docs/widgets/services/unifi-controller.md
+++ b/docs/widgets/services/unifi-controller.md
@@ -9,7 +9,7 @@ _(Find the Unifi Controller information widget [here](../info/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.
From 276a1c3ef423f7b027a84ad5c8ac7ef30d04ca2f Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Thu, 28 Nov 2024 21:54:22 -0800
Subject: [PATCH 11/43] Chore: better tailscale error handling
---
src/widgets/tailscale/component.jsx | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
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
+
+
+ {t("resources.cpu")}
+ {t("resources.mem")}
+
+ {data.map((item) => (
+
+
+
+ ))}
+
+
+ {statusMap[item[statusKey]]}
+ {item.name}
+ {item.cpu_percent.toFixed(1)}%
+
+ {t("common.bytes", {
+ value: item.memory.usage,
+ maximumFractionDigits: 0,
+ })}
+
+
+### 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.
diff --git a/src/components/bookmarks/group.jsx b/src/components/bookmarks/group.jsx
index 3a9f8323a..9deb1b6a2 100644
--- a/src/components/bookmarks/group.jsx
+++ b/src/components/bookmarks/group.jsx
@@ -7,7 +7,13 @@ import ErrorBoundary from "components/errorboundry";
import List from "components/bookmarks/list";
import ResolvedIcon from "components/resolvedicon";
-export default function BookmarksGroup({ bookmarks, layout, disableCollapse, groupsInitiallyCollapsed }) {
+export default function BookmarksGroup({
+ bookmarks,
+ layout,
+ disableCollapse,
+ groupsInitiallyCollapsed,
+ bookmarksStyle,
+}) {
const panel = useRef();
useEffect(() => {
@@ -64,7 +70,7 @@ export default function BookmarksGroup({ bookmarks, layout, disableCollapse, gro
>