Compare commits

...
Author SHA1 Message Date
ajnart b2fcc94724 fix(weather): respect NO_EXTERNAL_CONNECTION in location search and surface weather data states 2026-08-22 17:14:43 +02:00
Thomas aca3b5d861 fix: correct Unraid CPU, link context menus, and board resizing (#6510)
Fix Unraid logical CPU averaging, preserve native context menus for app and bookmark widgets in view mode, and prevent scrollbar-width GridStack resize oscillation.
2026-08-22 10:53:26 +02:00
12 changed files with 270 additions and 54 deletions

No files matched your search

@@ -30,7 +30,7 @@ Using the `PUID` and `PGID` will require you to set the correct permissions on t
| `PUID` | User ID to run the container as | Any valid user ID | `0` |
| `PGID` | Group ID to run the container as | Any valid group ID | `0` |
| `LOG_LEVEL` | Log level to use | `debug` / `info` / `warn` / `error` | `info` |
| `NO_EXTERNAL_CONNECTION` | Disables Homarr's internet-backed requests, including update checks, weather, and RSS feeds | `true` or `false` | `false` |
| `NO_EXTERNAL_CONNECTION` | Disables Homarr's internet-backed requests, including update checks, weather, location search, and RSS feeds | `true` or `false` | `false` |
| `ENABLE_DNS_CACHING` | Enables dns caching. Enabled by default, but if you experience issues with IPv6 or static IPs, see [#4006](https://github.com/homarr-labs/homarr/issues/4006) or disable this flag | `true` or `false` | `true` |
| `HOMARR_DISABLE_IPV6` | Disables the IPv6 listener of the internal nginx proxy, even when the host supports IPv6. IPv6 is normally disabled automatically when the host has no IPv6 configured. See [#4596](https://github.com/homarr-labs/homarr/issues/4596) | `true` or `false` | `false` |
+13 -15
View File
@@ -1,30 +1,27 @@
---
title: 'App'
description: 'Embeds an app into the board.'
title: "App"
description: "Embeds an app into the board."
hide_title: true
---
import { AddingWidget } from '@site/src/components/widgets/adding';
import { WidgetConfig } from '@site/src/components/widgets/configuration';
import { WidgetHeader } from '@site/src/components/widgets/header';
import { appWidget } from '.';
import { AddingWidget } from "@site/src/components/widgets/adding";
import { WidgetConfig } from "@site/src/components/widgets/configuration";
import { WidgetHeader } from "@site/src/components/widgets/header";
import { appWidget } from ".";
<WidgetHeader
widget={appWidget}
categories={['Links', 'Apps']}
/>
<WidgetHeader widget={appWidget} categories={["Links", "Apps"]} />
The app widget allows you to add a link to an application or a website that you want to access quickly from your Homarr board.
It also supports a status check to indicate whether Homarr can reach the application or website.
In view mode, right-clicking uses the browser's link menu. Homarr's widget menu remains available in edit mode.
### Screenshots
import githubApp from './img/github.png';
import jellyseerrApp from './img/jellyseerr-description-tooltip.png';
import piHoleApp from './img/pi-hole-ping-icon.png';
import githubApp from "./img/github.png";
import jellyseerrApp from "./img/jellyseerr-description-tooltip.png";
import piHoleApp from "./img/pi-hole-ping-icon.png";
<div className='flex gap-1'>
<div className="flex gap-1">
<img src={githubApp} alt="app github with-status-check" width={128 * 1.5} height={128 * 1.5} />
<img src={piHoleApp} alt="app pi-hole with-status-check status-check-icon" width={128 * 1.5} height={128 * 1.5} />
<img src={jellyseerrApp} alt="app jellyseerr with-description-tooltip" height={128 * 1.5} />
@@ -34,4 +31,5 @@ import piHoleApp from './img/pi-hole-ping-icon.png';
<AddingWidget />
### Configuration
<WidgetConfig configuration={appWidget.configuration} />
+14 -16
View File
@@ -1,29 +1,26 @@
---
title: 'Bookmarks'
description: 'Displays multiple app links'
title: "Bookmarks"
description: "Displays multiple app links"
hide_title: true
---
import { AddingWidget } from '@site/src/components/widgets/adding';
import { WidgetConfig } from '@site/src/components/widgets/configuration';
import { WidgetHeader } from '@site/src/components/widgets/header';
import { bookmarksWidget } from '.';
import { AddingWidget } from "@site/src/components/widgets/adding";
import { WidgetConfig } from "@site/src/components/widgets/configuration";
import { WidgetHeader } from "@site/src/components/widgets/header";
import { bookmarksWidget } from ".";
<WidgetHeader
widget={bookmarksWidget}
categories={['Links', 'Apps']}
/>
<WidgetHeader widget={bookmarksWidget} categories={["Links", "Apps"]} />
The bookmarks widget allows you to display multiple app links in a single widget.
You can add links to your favorite applications, websites, or any other resources you want quick access to.
In view mode, right-clicking uses the browser's link menu. Homarr's widget menu remains available in edit mode.
### Screenshots
import gridIconsOnly from './img/grid-icons-only.png';
import gridWithTitle from './img/grid-with-title.png';
import verticalListAll from './img/vertical-list-all.png';
import vericalListSimple from './img/vertical-list-simple.png';
import gridIconsOnly from "./img/grid-icons-only.png";
import gridWithTitle from "./img/grid-with-title.png";
import verticalListAll from "./img/vertical-list-all.png";
import vericalListSimple from "./img/vertical-list-simple.png";
<div className='flex gap-1'>
<div className='flex flex-col gap-1'>
@@ -33,12 +30,13 @@ import vericalListSimple from './img/vertical-list-simple.png';
<img src={gridWithTitle} alt="bookmarks grid with-title" width={256 + 4} height={256 + 4} />
<img src={verticalListAll} alt="bookmarks vertical-list all-elements" width={128} height={256 + 4} />
</div>
</div>
### Adding the widget
<AddingWidget />
### Configuration
<WidgetConfig configuration={bookmarksWidget.configuration} />
+16 -14
View File
@@ -1,26 +1,22 @@
---
title: 'Weather'
description: 'Displays the current weather information of a set location.'
title: "Weather"
description: "Displays the current weather information of a set location."
hide_title: true
---
import { AddingWidget } from '@site/src/components/widgets/adding';
import { WidgetConfig } from '@site/src/components/widgets/configuration';
import { WidgetHeader } from '@site/src/components/widgets/header';
import { weatherWidget } from '.';
import { AddingWidget } from "@site/src/components/widgets/adding";
import { WidgetConfig } from "@site/src/components/widgets/configuration";
import { WidgetHeader } from "@site/src/components/widgets/header";
import { weatherWidget } from ".";
<WidgetHeader
widget={weatherWidget}
categories={["Weather"]}
/>
<WidgetHeader widget={weatherWidget} categories={["Weather"]} />
The Weather Widget uses your location to display the current, highest and lowest temperature.
### Screenshots
import forecastWeather from './img/forecast.png';
import currentWeather from './img/current.png';
import forecastWeather from "./img/forecast.png";
import currentWeather from "./img/current.png";
<div className="flex flex-col gap-1">
<img src={forecastWeather} alt="weather forecast-5-days" width={128 * 4.5} />
@@ -32,9 +28,15 @@ import currentWeather from './img/current.png';
<AddingWidget />
### Configuration
<WidgetConfig configuration={weatherWidget.configuration} />
### Data source
We use the Open Meteo API to fetch the weather and locations.
If you need to whitelist the api, please use the following URL: `https://open-meteo.com`
If you need to whitelist the api, please use the following URL: `https://open-meteo.com`
:::note
When the `NO_EXTERNAL_CONNECTION` environment variable is enabled, the widget (and the city
search inside its configuration) cannot load any data from Open Meteo.
:::
@@ -44,9 +44,13 @@ interface WidgetContextMenuProps {
export const WidgetContextMenu = ({ item, definition, widgetStateRef, children }: WidgetContextMenuProps) => {
const { data: session } = useSession();
const [isEditMode] = useEditMode();
const settings = useSettings();
if (!session || !settings.enableRightClickOnWidgets) return <>{children}</>;
const isLinkWidget = item.kind === "app" || item.kind === "bookmarks";
// Keep the Homarr menu in edit mode so these widgets can still be edited or removed.
if (isLinkWidget && !isEditMode) return <>{children}</>;
return (
<WidgetContextMenuInner item={item} definition={definition} widgetStateRef={widgetStateRef} settings={settings}>
@@ -301,6 +301,8 @@ interface UseCssVariableConfiguration {
isDynamic: boolean;
}
const minimumResizeWidthDelta = 20;
/**
* This hook is used to configure the css variables for the gridstack
* Those css variables are used to define the size of the gridstack items
@@ -319,9 +321,30 @@ const useCssVariableConfiguration = ({
columnCount,
isDynamic,
}: UseCssVariableConfiguration) => {
const prevSizeRef = useRef<{ width: number; height: number } | null>(null);
const onResize = useCallback(() => {
if (!wrapperRef.current) return;
if (!gridRef.current) return;
const currentWidth = wrapperRef.current.clientWidth;
const currentHeight = wrapperRef.current.clientHeight;
const prevSize = prevSizeRef.current;
// Only skip recalculation when the width change is insignificant
// and, for dynamic sections, the height is unchanged. This prevents infinite
// feedback loops when the vertical scrollbar appears/disappears, causing
// clientWidth to oscillate by ~15px, while still reacting to height changes.
if (
prevSize !== null &&
Math.abs(currentWidth - prevSize.width) < minimumResizeWidthDelta &&
(!isDynamic || currentHeight === prevSize.height)
) {
return;
}
prevSizeRef.current = { width: currentWidth, height: currentHeight };
handleResizeChange(
wrapperRef.current,
gridRef.current,
+3
View File
@@ -1,5 +1,6 @@
import { z } from "zod/v4";
import { env } from "@homarr/common/env";
import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
import { withTimeoutAsync } from "@homarr/core/infrastructure/http/timeout";
@@ -37,6 +38,8 @@ export const locationRouter = createTRPCRouter({
.input(locationSearchCityInput)
.output(locationSearchCityOutput)
.query(async ({ input }) => {
if (env.NO_EXTERNAL_CONNECTION) return { results: [] };
const res = await withTimeoutAsync(async (signal) => {
return await fetchWithTrustedCertificatesAsync(
`https://geocoding-api.open-meteo.com/v1/search?name=${input.query}`,
@@ -0,0 +1,80 @@
import { afterEach, describe, expect, test, vi } from "vitest";
import { createDb } from "@homarr/db/test";
const mocks = vi.hoisted(() => ({
fetchWithTrustedCertificatesAsync: vi.fn(),
env: { NO_EXTERNAL_CONNECTION: false },
}));
vi.mock("@homarr/common/env", () => ({
env: mocks.env,
}));
vi.mock("@homarr/core/infrastructure/http", () => ({
fetchWithTrustedCertificatesAsync: mocks.fetchWithTrustedCertificatesAsync,
}));
vi.mock("@homarr/core/infrastructure/http/timeout", () => ({
withTimeoutAsync: async (callback: (signal: AbortSignal) => Promise<Response>) => {
return await callback(new AbortController().signal);
},
}));
import { locationRouter } from "../location";
const createJsonResponse = (body: unknown) =>
new Response(JSON.stringify(body), { status: 200, headers: { "content-type": "application/json" } });
const createCaller = () => locationRouter.createCaller({ db: createDb(), deviceType: undefined, session: null });
afterEach(() => {
mocks.env.NO_EXTERNAL_CONNECTION = false;
mocks.fetchWithTrustedCertificatesAsync.mockReset();
});
describe("locationRouter.searchCity", () => {
test("should return empty results when external connections are disabled", async () => {
// Arrange
mocks.env.NO_EXTERNAL_CONNECTION = true;
const caller = createCaller();
// Act
const result = await caller.searchCity({ query: "Paris" });
// Assert
expect(result.results).toEqual([]);
expect(mocks.fetchWithTrustedCertificatesAsync).not.toHaveBeenCalled();
});
test("should fetch the geocoding API when external connections are enabled", async () => {
// Arrange
mocks.env.NO_EXTERNAL_CONNECTION = false;
mocks.fetchWithTrustedCertificatesAsync.mockResolvedValue(
createJsonResponse({
results: [
{
id: 1,
name: "Paris",
country: "France",
country_code: "FR",
latitude: 48.85341,
longitude: 2.3488,
population: 2138551,
},
],
}),
);
const caller = createCaller();
// Act
const result = await caller.searchCity({ query: "Paris" });
// Assert
expect(result.results[0]?.name).toBe("Paris");
expect(mocks.fetchWithTrustedCertificatesAsync).toHaveBeenCalledWith(
expect.stringContaining("geocoding-api.open-meteo.com"),
expect.anything(),
);
});
});
@@ -0,0 +1,64 @@
import { afterEach, describe, expect, test, vi } from "vitest";
import { createDb } from "@homarr/db/test";
const mocks = vi.hoisted(() => ({
getDataAsync: vi.fn(),
handler: vi.fn(),
env: { NO_EXTERNAL_CONNECTION: false },
}));
vi.mock("@homarr/common/env", () => ({
env: mocks.env,
}));
vi.mock("@homarr/request-handler/weather", () => ({
weatherRequestHandler: {
handler: mocks.handler,
},
}));
import { weatherRouter } from "../../widgets/weather";
const weatherData = {
current: { weathercode: 0, temperature: 20, windspeed: 10 },
daily: [],
};
const createCaller = () => weatherRouter.createCaller({ db: createDb(), deviceType: undefined, session: null });
afterEach(() => {
mocks.env.NO_EXTERNAL_CONNECTION = false;
mocks.handler.mockReset();
mocks.getDataAsync.mockReset();
});
describe("weatherRouter.atLocation", () => {
test("should return null when external connections are disabled", async () => {
// Arrange
mocks.env.NO_EXTERNAL_CONNECTION = true;
const caller = createCaller();
// Act
const result = await caller.atLocation({ latitude: 48.85341, longitude: 2.3488 });
// Assert
expect(result).toBeNull();
expect(mocks.handler).not.toHaveBeenCalled();
});
test("should return the weather data when external connections are enabled", async () => {
// Arrange
mocks.env.NO_EXTERNAL_CONNECTION = false;
mocks.handler.mockReturnValue({ getDataAsync: mocks.getDataAsync });
mocks.getDataAsync.mockResolvedValue({ data: weatherData, timestamp: new Date() });
const caller = createCaller();
// Act
const result = await caller.atLocation({ latitude: 48.85341, longitude: 2.3488 });
// Assert
expect(result).toEqual(weatherData);
expect(mocks.handler).toHaveBeenCalledWith({ latitude: 48.85341, longitude: 2.3488 });
});
});
@@ -37,9 +37,16 @@ export class UnraidIntegration extends Integration implements ISystemHealthMonit
const systemInfo = await this.getSystemInformationAsync();
const cpuUtilization = systemInfo.metrics.cpu.cpus.reduce((acc, val) => acc + val.percentTotal, 0);
const cpuCount = systemInfo.info.cpu.cores;
const cpuCount = systemInfo.metrics.cpu.cpus.length;
// Each entry in cpus[] is one logical CPU (thread). Dividing the summed per-thread
// utilization by the thread count (not physical cores) gives the correct average and
// avoids over-reporting on SMT systems. Guard against zero to avoid Infinity/NaN.
let cpuUtilizationNormalized = 0;
if (cpuCount > 0) {
cpuUtilizationNormalized = cpuUtilization / cpuCount;
}
// We use "info" object instead of the stats since this is the exact amount the kernel sees, which is what Unraid displays.
const totalMemory = systemInfo.info.memory.layout.reduce((acc, layout) => layout.size + acc, 0);
const usedMemory = totalMemory * (systemInfo.metrics.memory.percentTotal / 100);
const uptime = dayjs(systemInfo.info.os.uptime);
@@ -47,7 +54,7 @@ export class UnraidIntegration extends Integration implements ISystemHealthMonit
return {
version: systemInfo.info.os.release,
cpuModelName: systemInfo.info.cpu.brand,
cpuUtilization: cpuUtilization / cpuCount,
cpuUtilization: cpuUtilizationNormalized,
memUsedInBytes: usedMemory,
memAvailableInBytes: totalMemory - usedMemory,
uptime: dayjs().diff(uptime, "seconds"),
@@ -139,7 +146,7 @@ export class UnraidIntegration extends Integration implements ISystemHealthMonit
},
memory {
layout {
size
size
}
}
}
+5
View File
@@ -2309,6 +2309,11 @@
}
},
"currentWindSpeed": "{currentWindSpeed} {unit}",
"error": {
"disabled": "Weather data is unavailable because outbound connections are disabled",
"failed": "Failed to load weather data",
"retry": "Retry"
},
"dailyForecast": {
"sunrise": "Sunrise",
"sunset": "Sunset",
+36 -4
View File
@@ -1,7 +1,14 @@
"use client";
import { Box, Group, HoverCard, Stack, Text } from "@mantine/core";
import { IconArrowDownRight, IconArrowUpRight, IconDroplets, IconMapPin, IconWind } from "@tabler/icons-react";
import { Box, Button, Group, HoverCard, Stack, Text } from "@mantine/core";
import {
IconArrowDownRight,
IconArrowUpRight,
IconCloudOff,
IconDroplets,
IconMapPin,
IconWind,
} from "@tabler/icons-react";
import combineClasses from "clsx";
import dayjs from "dayjs";
@@ -16,13 +23,38 @@ import { AnimatedWeatherIcon } from "./animated-icon";
import { WeatherDescription } from "./icon";
export default function WeatherWidget({ isEditMode, options }: WidgetComponentProps<"weather">) {
const tError = useScopedI18n("widget.weather.error");
const input = {
latitude: options.location.latitude,
longitude: options.location.longitude,
};
const { data: weather } = clientApi.widget.weather.atLocation.useQuery(input);
const { data: weather, isPending, isError, refetch } = clientApi.widget.weather.atLocation.useQuery(input);
if (!weather) return <WidgetEmptyState />;
if (isPending) return <WidgetEmptyState />;
if (isError) {
return (
<Stack align="center" justify="center" gap="xs" w="100%" h="100%" p="sm">
<IconCloudOff size={24} />
<Text c="red" size="sm" ta="center">
{tError("failed")}
</Text>
<Button variant="subtle" size="compact-xs" onClick={() => void refetch()}>
{tError("retry")}
</Button>
</Stack>
);
}
if (!weather) {
return (
<Stack align="center" justify="center" gap="xs" w="100%" h="100%" p="sm">
<Text c="dimmed" size="sm" ta="center">
{tError("disabled")}
</Text>
</Stack>
);
}
return (
<Stack