Avoid need for version increment

gethomepage · Mar 1, 2025 · 158da55 · 158da55
1 parent b17c79c
commit 158da55
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 32 deletions.
diff --git a/docs/widgets/info/unifi_controller.md b/docs/widgets/info/unifi_controller.md
@@ -19,19 +19,11 @@ An optional 'site' parameter can be supplied, if it is not the widget will use t
 
 <img width="162" alt="unifi_infowidget" src="https://user-images.githubusercontent.com/4887959/197706832-f5a8706b-7282-4892-a666-b7d999752562.png">
 
-Version 2 of the widget supports the Unifi Network API (2024) which requires an API key instead of a username and password. The API key can be generated in the Unifi Controller under Settings > Control Plane > Integrations
-
-| Unifi API          | Homepage Widget Version |
-| ------------------ | ----------------------- |
-| Controller API     | 1 (default)             |
-| Network API (2024) | 2                       |
-
 ```yaml
 - unifi_console:
     url: https://unifi.host.or.ip:port
     site: Site Name # optional
-    username: user # version 1
-    password: pass # version 1
-    key: unifiapikey # version 2
-    version: 2 # default is 1
+    username: user
+    password: pass
+    key: unifiapikey # required if using API key instead of username/password
 ```
diff --git a/docs/widgets/services/unifi-controller.md b/docs/widgets/services/unifi-controller.md
@@ -21,20 +21,12 @@ Allowed fields: `["uptime", "wan", "lan", "lan_users", "lan_devices", "wlan", "w
 
     If you enter e.g. incorrect credentials and receive an "API Error", you may need to recreate the container or restart the service to clear the cache.
 
-Version 2 of the widget supports the Unifi Network API (2024) which requires an API key instead of a username and password. The API key can be generated in the Unifi Controller under Settings > Control Plane > Integrations
-
-| Unifi API          | Homepage Widget Version |
-| ------------------ | ----------------------- |
-| Controller API     | 1 (default)             |
-| Network API (2024) | 2                       |
-
 ```yaml
 widget:
   type: unifi
   url: https://unifi.host.or.ip:port
   site: Site Name # optional
-  username: user # version 1
-  password: pass # version 1
-  key: unifiapikey # version 2
-  version: 2 # default is 1
+  username: user
+  password: pass
+  key: unifiapikey # required if using API key instead of username/password
 ```
diff --git a/src/utils/config/service-helpers.js b/src/utils/config/service-helpers.js
@@ -304,7 +304,7 @@ export function cleanServiceGroups(groups) {
           // frigate
           enableRecentEvents,
 
-          // beszel, glances, immich, mealie, pihole, pfsense, speedtest, unifi
+          // beszel, glances, immich, mealie, pihole, pfsense, speedtest
           version,
 
           // glances
@@ -482,7 +482,7 @@ export function cleanServiceGroups(groups) {
           if (snapshotHost) widget.snapshotHost = snapshotHost;
           if (snapshotPath) widget.snapshotPath = snapshotPath;
         }
-        if (["beszel", "glances", "immich", "mealie", "pfsense", "pihole", "speedtest", "unifi"].includes(type)) {
+        if (["beszel", "glances", "immich", "mealie", "pfsense", "pihole", "speedtest"].includes(type)) {
           if (version) widget.version = parseInt(version, 10);
         }
         if (type === "glances") {

diff --git a/src/utils/config/widget-helpers.js b/src/utils/config/widget-helpers.js
@@ -57,7 +57,7 @@ export async function getPrivateWidgetOptions(type, widgetIndex) {
   const widgets = await widgetsFromConfig();
 
   const privateOptions = widgets.map((widget) => {
-    const { index, url, username, password, key, apiKey, version } = widget.options;
+    const { index, url, username, password, key, apiKey } = widget.options;
 
     return {
       type: widget.type,
@@ -68,7 +68,6 @@ export async function getPrivateWidgetOptions(type, widgetIndex) {
         password,
         key,
         apiKey,
-        version,
       },
     };
   });

diff --git a/src/widgets/unifi/proxy.js b/src/widgets/unifi/proxy.js
@@ -74,15 +74,15 @@ export default async function unifiProxyHandler(req, res) {
 
   let [status, contentType, data, responseHeaders] = [];
   let prefix = cache.get(`${prefixCacheKey}.${service}`);
-  const headers = {};
   let csrfToken;
-  if (widget.version === 2) {
-    prefix = "/proxy/network";
+  const headers = {};
+  if (widget.key) {
+    prefix = udmpPrefix;
     headers["X-API-KEY"] = widget.key;
     headers["Content-Type"] = "application/json";
   } else if (prefix === null) {
-    // auto detect if we're talking to a UDM Pro, and cache the result so that we
-    // don't make two requests each time data from Unifi is required
+    // auto detect if we're talking to a UDM Pro or Network API device, and cache the result
+    // so that we don't make two requests each time data from Unifi is required
     [status, contentType, data, responseHeaders] = await httpProxy(widget.url);
     prefix = "";
     if (responseHeaders?.["x-csrf-token"]) {
@@ -104,7 +104,7 @@ export default async function unifiProxyHandler(req, res) {
 
   [status, contentType, data, responseHeaders] = await httpProxy(url, params);
 
-  if (status === 401 && widget.version < 2) {
+  if (status === 401 && !widget.key) {
     logger.debug("Unifi isn't logged in or rejected the reqeust, attempting login.");
     if (responseHeaders?.["x-csrf-token"]) {
       csrfToken = responseHeaders["x-csrf-token"];