chore: use Bun package management and Turbo remote caching (#6978)

* feat: migrate tooling and runtimes to bun

* fix: serialize act installs and adapt backup checks

* fix: finish bun scripts and rootless act setup

* fix: support bun images in runtime benchmarks

* fix: keep a single bun toolchain configuration

* fix: include docs mascot sources in workshop build

* docs: use bun in remaining tool commands

* fix: complete bun sqlite development tooling

* docs: explain sqlite development adapter

* fix: align remaining commands and local ci validation

* fix: use renovate regex fallback with bun

* fix: finalize bun sqlite connections during cleanup

* fix: preserve sqlite foreign key enforcement

* fix: align docker build frontends

* fix: prepare release versions with bun

* Add Bun benchmarks and preserve SQLite connection defaults

* Benchmark Bun installs, conflicts and production workloads

* Force Bun workspace tools and HTTP/1.1 upstream streaming

* Exclude benchmark evidence from Docker contexts

* Expose branch benchmarks through CI

* Verify hydrated widget data in production benchmarks

* Measure image archives and document benchmark protocol

* Audit dependency sharing across every workspace

* Pin pnpm for nested baseline benchmark scripts

* Preserve nested manager pinning on benchmark resume

* Include application and runtime image footprints

* Fail benchmark gates on candidate command errors

* Report complete build overhead and sampled memory bounds

* Validate migration comparisons across pinned revisions

* Record configurable runtime memory budgets

* Retain out-of-memory kills in runtime budget probes

* Reject OOM events consistently across runtime metrics

* Record complete Bun migration benchmarks

* Record memory diagnosis and correct Turbo caching

* Use Bun package management while preserving Node runtimes

* Keep native build fallbacks and exclude development artifacts

* Fix Node ESM metadata and isolate local CI configuration

* Measure development performance and isolate act environment

* Support isolated environment files in rootless act

* Validate the full migration range with act

* Preserve native SQLite binding for bundled migrations

* Use documented dev defaults and report benchmark scope

* Validate dev defaults and isolate restart measurements

* Record package-manager and development benchmarks

* Keep benchmark measurements and link full command artifacts

* Clean up temporary act environment files

* Validate Node runtimes in package-manager comparisons

* Validate every workspace in manual CI runs

* Retain patched nested brace expansion versions

* Complete package-manager and Node performance report

* Normalize archived benchmark logs

* Record final hosted validation

* Cache both Next builds with platform isolation

* Prime cache with write-only mode

* Split Next artifacts below Cloudflare upload limit

* Assemble coherent standalone cache outputs

* Preserve traced middleware entrypoints

* Assemble traced directory links before files

* Separate cached dependencies from assembled output

* Record signed Turbo cache benchmarks

* Remove archived benchmark captures

Full benchmark evidence is preserved at 8f7d3bcd14109bfb13fa664d31710b88d820ad66.

* Remove migration benchmark harness

* fix: correct migration launch and local Act prerequisites

* Consolidate Turbo caches and production artifacts

* Exclude generated files from Docker cache inputs

* fix: address Bun migration review findings

* fix: check restored compiler bundle manifests
This commit is contained in:
Thomas authored and GitHub committed 2026-10-07 16:38:14 +02:00
1 parent dc5f382875
commit 229bd4b3ed
109 files changed
+8507 -28875

No files matched your search

+31 -87
View File
@@ -1,104 +1,48 @@
import fs from "node:fs/promises";
import path, { dirname } from "node:path";
import { fileURLToPath } from "node:url";
import { XMLParser } from "fast-xml-parser";
import { z } from "zod/v4";
import { createDocumentationLink } from "./index";
import { widgetDocSlugs } from "./widget-doc-slugs";
import { getIntegrationDocumentationSlug, integrationKinds } from "../integration";
import { createDocumentationMetadata, documentationSitemapUrl, parseDocumentationSitemap } from "./metadata";
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
const snapshotUrl = new URL("./sitemap-paths.json", import.meta.url);
const outputUrl = new URL("./homarr-docs-sitemap.ts", import.meta.url);
const removeCommonUrl = (url: string) => {
return url.replace("https://homarr.dev", "");
};
const sitemapSchema = z.object({
urlset: z.object({
url: z.array(
z.object({
loc: z.string(),
}),
),
}),
});
const fetchSitemapAsync = async () => {
const response = await fetch(createDocumentationLink("/sitemap.xml"));
return await response.text();
};
const parseXml = (sitemapXml: string) => {
const parser = new XMLParser();
const data: unknown = parser.parse(sitemapXml);
const result = sitemapSchema.safeParse(data);
if (!result.success) {
throw new Error("Invalid sitemap schema");
const writeIfChangedAsync = async (url: URL, content: string) => {
let existing: string | undefined;
try {
existing = await fs.readFile(url, "utf8");
} catch (error) {
if (!(error instanceof Error) || !("code" in error) || error.code !== "ENOENT") {
throw error;
}
}
return result.data;
if (existing !== content) {
await fs.writeFile(url, content);
}
};
const mapSitemapXmlToPaths = (sitemapData: z.infer<typeof sitemapSchema>) => {
return sitemapData.urlset.url.map((url) => removeCommonUrl(url.loc));
};
const createSitemapPathType = (paths: string[]) => {
return "export type HomarrDocumentationPath =\n" + paths.map((path) => ` | "${path.replace(/\/$/, "")}"`).join("\n");
};
const updateSitemapTypeFileAsync = async (sitemapPathType: string) => {
const content =
"// This file is auto-generated by the codegen script\n" +
"// it uses the sitemap.xml to generate the HomarrDocumentationPath type\n" +
sitemapPathType +
";\n";
await fs.writeFile(outputPath, content);
};
const slugMapPaths = [
...integrationKinds
.map(getIntegrationDocumentationSlug)
.filter(Boolean)
.map((slug) => `/docs/integrations/${slug}`),
...Object.values(widgetDocSlugs)
.filter(Boolean)
.map((slug) => `/docs/widgets/${slug}`),
];
const outputPath = path.join(__dirname, "homarr-docs-sitemap.ts");
const main = async () => {
let paths: string[];
try {
const sitemapXml = await fetchSitemapAsync();
const sitemapData = parseXml(sitemapXml);
paths = mapSitemapXmlToPaths(sitemapData);
} catch {
const exists = await fs.access(outputPath).then(
() => true,
() => false,
);
if (exists) {
console.warn("Could not fetch sitemap from homarr.dev, keeping existing generated file");
return;
}
console.warn("Could not fetch sitemap from homarr.dev and no existing file, generating from slug maps only");
paths = [];
const args = process.argv.slice(2);
if (args.length > 1 || (args.length === 1 && args[0] !== "--refresh")) {
throw new Error("Usage: codegen.ts [--refresh]");
}
paths.push("/sitemap.xml", "/blog", "/search");
for (const p of slugMapPaths) {
if (!paths.includes(p)) {
paths.push(p);
let sitemapPaths: string[];
if (args.includes("--refresh")) {
const response = await fetch(documentationSitemapUrl, { signal: AbortSignal.timeout(30_000) });
if (!response.ok) {
throw new Error(`Could not refresh documentation sitemap: HTTP ${response.status}`);
}
sitemapPaths = parseDocumentationSitemap(await response.text());
} else {
sitemapPaths = z.array(z.string()).parse(JSON.parse(await fs.readFile(snapshotUrl, "utf8")));
}
const sitemapPathType = createSitemapPathType(paths);
await updateSitemapTypeFileAsync(sitemapPathType);
const metadata = createDocumentationMetadata(sitemapPaths);
if (args.includes("--refresh")) {
await writeIfChangedAsync(snapshotUrl, metadata.snapshot);
}
await writeIfChangedAsync(outputUrl, metadata.source);
};
void main();
await main();
@@ -1,47 +1,100 @@
// This file is auto-generated by the codegen script
// it uses the sitemap.xml to generate the HomarrDocumentationPath type
// Generated from sitemap-paths.json and local documentation slugs.
// Update offline with docs:generate; refresh the pinned sitemap with docs:refresh.
export type HomarrDocumentationPath =
| "/search"
| ""
| "/about-us"
| "/api-reference"
| "/api-reference/apps/appRouter-all"
| "/api-reference/apps/appRouter-byId"
| "/api-reference/apps/appRouter-create"
| "/api-reference/apps/appRouter-delete"
| "/api-reference/apps/appRouter-getPaginated"
| "/api-reference/apps/appRouter-search"
| "/api-reference/apps/appRouter-selectable"
| "/api-reference/apps/appRouter-update"
| "/api-reference/boards/boardRouter-addItem"
| "/api-reference/boards/boardRouter-changeBoardVisibility"
| "/api-reference/boards/boardRouter-createBoard"
| "/api-reference/boards/boardRouter-deleteBoard"
| "/api-reference/boards/boardRouter-duplicateBoard"
| "/api-reference/boards/boardRouter-getAllBoards"
| "/api-reference/boards/boardRouter-renameBoard"
| "/api-reference/boards/boardRouter-savePartialBoardSettings"
| "/api-reference/boards/boardRouter-setHomeBoard"
| "/api-reference/boards/boardRouter-setMobileHomeBoard"
| "/api-reference/boards/boardRouter-updateItemLayout"
| "/api-reference/info/infoRouter-getInfo"
| "/api-reference/integrations/integration-request"
| "/api-reference/invites/inviteRouter-createInvite"
| "/api-reference/invites/inviteRouter-deleteInvite"
| "/api-reference/invites/inviteRouter-getAll"
| "/api-reference/settings/serverSettingsRouter-getBoardSettings"
| "/api-reference/settings/serverSettingsRouter-updateBoardSettings"
| "/api-reference/users/userRouter-changeColorScheme"
| "/api-reference/users/userRouter-changeDdgBangs"
| "/api-reference/users/userRouter-changeDefaultSearchEngine"
| "/api-reference/users/userRouter-changeEnableRightClickOnWidgets"
| "/api-reference/users/userRouter-changeFirstDayOfWeek"
| "/api-reference/users/userRouter-changeHeaderPreferences"
| "/api-reference/users/userRouter-changeHomeBoards"
| "/api-reference/users/userRouter-changePassword"
| "/api-reference/users/userRouter-changeSearchPreferences"
| "/api-reference/users/userRouter-create"
| "/api-reference/users/userRouter-delete"
| "/api-reference/users/userRouter-editProfile"
| "/api-reference/users/userRouter-getAll"
| "/api-reference/users/userRouter-getById"
| "/api-reference/users/userRouter-search"
| "/api-reference/users/userRouter-selectable"
| "/api-reference/users/userRouter-setProfileImage"
| "/blog"
| "/blog/2023/01/11/version0.11"
| "/blog/2023/04/16/version0.12-more-widgets"
| "/blog/2023/11/10/authentication"
| "/blog/2023/12/22/updated-documentation"
| "/blog/2024/09/23/version-1.0"
| "/blog/2024/12/17/open-beta-1.0"
| "/blog/2025/01/19/migration-guide-1.0"
| "/blog/2025/08/02/using-argus"
| "/blog/2026/09/03/homarr-2.0"
| "/blog/documentation-migration"
| "/blog/translations"
| "/docs"
| "/docs/advanced"
| "/docs/advanced/mysql-to-sqlite"
| "/docs/getting-started/after-the-installation"
| "/docs/getting-started/glossary"
| "/docs/getting-started"
| "/docs/community/donate"
| "/docs/community/faq"
| "/docs/community/get-in-touch"
| "/docs/community"
| "/docs/community/license"
| "/docs/community/translations"
| "/docs/management/assistant"
| "/docs/management/backup"
| "/docs/management"
| "/docs/management/mcp"
| "/docs/integrations"
| "/docs/workshop/homarr-provider"
| "/docs/workshop"
| "/docs/widgets"
| "/docs/advanced/command-line"
| "/docs/advanced/environment-variables"
| "/docs/advanced/command-line/development"
| "/docs/advanced/command-line/fix-usernames"
| "/docs/advanced/command-line/integrations"
| "/docs/advanced/command-line/password-recovery"
| "/docs/advanced/command-line/users"
| "/docs/advanced/development/getting-started"
| "/docs/advanced/development/kubernetes"
| "/docs/advanced/development/widgets-and-integrations"
| "/docs/advanced/development/workshop-operator"
| "/docs/advanced/development/workshop"
| "/docs/advanced/development/workshop-operator"
| "/docs/advanced/environment-variables"
| "/docs/advanced/icons"
| "/docs/advanced/keyboard-shortcuts"
| "/docs/advanced/running-as-different-user"
| "/docs/advanced/mysql-to-sqlite"
| "/docs/advanced/proxy"
| "/docs/advanced/running-as-different-user"
| "/docs/advanced/single-sign-on"
| "/docs/advanced/styling"
| "/docs/community"
| "/docs/community/donate"
| "/docs/community/faq"
| "/docs/community/get-in-touch"
| "/docs/community/license"
| "/docs/community/translations"
| "/docs/getting-started"
| "/docs/getting-started/after-the-installation"
| "/docs/getting-started/glossary"
| "/docs/getting-started/installation"
| "/docs/getting-started/installation/docker"
| "/docs/getting-started/installation/easy-panel"
| "/docs/getting-started/installation/helm"
| "/docs/getting-started/installation/home-assistant"
| "/docs/getting-started/installation/hostinger"
| "/docs/getting-started/installation"
| "/docs/getting-started/installation/pika-pods"
| "/docs/getting-started/installation/portainer"
| "/docs/getting-started/installation/proxmox"
@@ -52,24 +105,7 @@ export type HomarrDocumentationPath =
| "/docs/getting-started/installation/source"
| "/docs/getting-started/installation/synology"
| "/docs/getting-started/installation/unraid"
| "/docs/management/api"
| "/docs/management/apps"
| "/docs/management/boards"
| "/docs/management/certificates"
| "/docs/management/custom-widgets/agent-authoring"
| "/docs/management/custom-widgets/authoring"
| "/docs/management/custom-widgets/component-reference"
| "/docs/management/custom-widgets/custom-jsx"
| "/docs/management/custom-widgets"
| "/docs/management/custom-widgets/requests-and-security"
| "/docs/management/custom-widgets/troubleshooting"
| "/docs/management/logs"
| "/docs/management/media"
| "/docs/management/integrations"
| "/docs/management/search-engines"
| "/docs/management/settings"
| "/docs/management/tasks"
| "/docs/management/users"
| "/docs/integrations"
| "/docs/integrations/adguard-home"
| "/docs/integrations/anchor"
| "/docs/integrations/archiveteam-warrior"
@@ -161,6 +197,29 @@ export type HomarrDocumentationPath =
| "/docs/integrations/whats-up-docker"
| "/docs/integrations/xteve"
| "/docs/integrations/your-spotify"
| "/docs/management"
| "/docs/management/api"
| "/docs/management/apps"
| "/docs/management/assistant"
| "/docs/management/backup"
| "/docs/management/boards"
| "/docs/management/certificates"
| "/docs/management/custom-widgets"
| "/docs/management/custom-widgets/agent-authoring"
| "/docs/management/custom-widgets/authoring"
| "/docs/management/custom-widgets/component-reference"
| "/docs/management/custom-widgets/custom-jsx"
| "/docs/management/custom-widgets/requests-and-security"
| "/docs/management/custom-widgets/troubleshooting"
| "/docs/management/integrations"
| "/docs/management/logs"
| "/docs/management/mcp"
| "/docs/management/media"
| "/docs/management/search-engines"
| "/docs/management/settings"
| "/docs/management/tasks"
| "/docs/management/users"
| "/docs/widgets"
| "/docs/widgets/air-quality"
| "/docs/widgets/anchor-note"
| "/docs/widgets/app"
@@ -185,6 +244,9 @@ export type HomarrDocumentationPath =
| "/docs/widgets/firewall"
| "/docs/widgets/health-monitoring"
| "/docs/widgets/iframe"
| "/docs/widgets/immich-album-carousel"
| "/docs/widgets/immich-server-stats"
| "/docs/widgets/indexer-manager"
| "/docs/widgets/llama-cpp"
| "/docs/widgets/media-missing"
| "/docs/widgets/media-releases"
@@ -196,9 +258,6 @@ export type HomarrDocumentationPath =
| "/docs/widgets/network-controller-status"
| "/docs/widgets/network-controller-summary"
| "/docs/widgets/notebook"
| "/docs/widgets/immich-server-stats"
| "/docs/widgets/immich-album-carousel"
| "/docs/widgets/indexer-manager"
| "/docs/widgets/notifications"
| "/docs/widgets/paperless-ngx"
| "/docs/widgets/patchmon"
@@ -210,6 +269,7 @@ export type HomarrDocumentationPath =
| "/docs/widgets/stats"
| "/docs/widgets/stock-price"
| "/docs/widgets/system-disks"
| "/docs/widgets/system-resources"
| "/docs/widgets/timer"
| "/docs/widgets/timetable"
| "/docs/widgets/tracearr"
@@ -221,215 +281,8 @@ export type HomarrDocumentationPath =
| "/docs/widgets/vpn"
| "/docs/widgets/weather"
| "/docs/widgets/whats-up-docker"
| "/docs/advanced/command-line/development"
| "/docs/advanced/command-line/fix-usernames"
| "/docs/advanced/command-line/integrations"
| "/docs/advanced/command-line/password-recovery"
| "/docs/advanced/command-line/users"
| "/docs/widgets/system-resources"
| "/api-reference/apps/appRouter-getPaginated"
| "/api-reference/apps/appRouter-all"
| "/api-reference/apps/appRouter-create"
| "/api-reference/apps/appRouter-search"
| "/api-reference/apps/appRouter-selectable"
| "/api-reference/apps/appRouter-byId"
| "/api-reference/apps/appRouter-update"
| "/api-reference/apps/appRouter-delete"
| "/api-reference/boards/boardRouter-getAllBoards"
| "/api-reference/boards/boardRouter-createBoard"
| "/api-reference/boards/boardRouter-duplicateBoard"
| "/api-reference/boards/boardRouter-renameBoard"
| "/api-reference/boards/boardRouter-changeBoardVisibility"
| "/api-reference/boards/boardRouter-deleteBoard"
| "/api-reference/boards/boardRouter-setHomeBoard"
| "/api-reference/boards/boardRouter-setMobileHomeBoard"
| "/api-reference/boards/boardRouter-savePartialBoardSettings"
| "/api-reference/boards/boardRouter-addItem"
| "/api-reference/boards/boardRouter-updateItemLayout"
| "/api-reference/info/infoRouter-getInfo"
| "/api-reference/invites/inviteRouter-getAll"
| "/api-reference/invites/inviteRouter-createInvite"
| "/api-reference/invites/inviteRouter-deleteInvite"
| "/api-reference/settings/serverSettingsRouter-getBoardSettings"
| "/api-reference/settings/serverSettingsRouter-updateBoardSettings"
| "/api-reference/users/userRouter-getAll"
| "/api-reference/users/userRouter-create"
| "/api-reference/users/userRouter-setProfileImage"
| "/api-reference/users/userRouter-selectable"
| "/api-reference/users/userRouter-search"
| "/api-reference/users/userRouter-getById"
| "/api-reference/users/userRouter-delete"
| "/api-reference/users/userRouter-editProfile"
| "/api-reference/users/userRouter-changePassword"
| "/api-reference/users/userRouter-changeHomeBoards"
| "/api-reference/users/userRouter-changeDefaultSearchEngine"
| "/api-reference/users/userRouter-changeSearchPreferences"
| "/api-reference/users/userRouter-changeColorScheme"
| "/api-reference/users/userRouter-changeEnableRightClickOnWidgets"
| "/api-reference/users/userRouter-changeHeaderPreferences"
| "/api-reference/users/userRouter-changeDdgBangs"
| "/api-reference/users/userRouter-changeFirstDayOfWeek"
| "/api-reference/integrations/integration-request"
| "/blog/translations"
| "/blog/2024/09/23/version-1.0"
| "/blog/2024/12/17/open-beta-1.0"
| "/blog/documentation-migration"
| "/blog/2023/01/11/version0.11"
| "/blog/2023/04/16/version0.12-more-widgets"
| "/blog/2023/12/22/updated-documentation"
| "/blog/2023/11/10/authentication"
| "/blog/2025/01/19/migration-guide-1.0"
| "/blog/2026/09/03/homarr-2.0"
| "/blog/2025/08/02/using-argus"
| "/workshop"
| "/api-reference"
| "/about-us"
| "/docs/workshop"
| "/docs/workshop/homarr-provider"
| "/search"
| "/sitemap.xml"
| "/docs/integrations/autobrr"
| "/docs/integrations/jellystat"
| "/docs/integrations/scrutiny"
| "/docs/integrations/tubearchivist"
| "/docs/integrations/frigate"
| "/docs/integrations/komga"
| "/docs/integrations/netalertx"
| "/docs/integrations/jackett"
| "/docs/integrations/your-spotify"
| "/docs/integrations/romm"
| "/docs/integrations/homebox"
| "/docs/integrations/mealie"
| "/docs/integrations/xteve"
| "/docs/integrations/unmanic"
| "/docs/integrations/syncthing-relay"
| "/docs/integrations/stash"
| "/docs/integrations/prometheus"
| "/docs/integrations/plantit"
| "/docs/integrations/netdata"
| "/docs/integrations/fileflows"
| "/docs/integrations/trilium"
| "/docs/integrations/tandoor"
| "/docs/integrations/spoolman"
| "/docs/integrations/miniflux"
| "/docs/integrations/maintainerr"
| "/docs/integrations/linkwarden"
| "/docs/integrations/karakeep"
| "/docs/integrations/healthchecks"
| "/docs/integrations/gatus"
| "/docs/integrations/changedetection"
| "/docs/integrations/caddy"
| "/docs/integrations/sabnzbd"
| "/docs/integrations/nzbget"
| "/docs/integrations/deluge"
| "/docs/integrations/transmission"
| "/docs/integrations/q-bittorent"
| "/docs/integrations/aria2"
| "/docs/integrations/slskd"
| "/docs/integrations/sonarr"
| "/docs/integrations/radarr"
| "/docs/integrations/lidarr"
| "/docs/integrations/readarr"
| "/docs/integrations/bindery"
| "/docs/integrations/prowlarr"
| "/docs/integrations/bazarr"
| "/docs/integrations/jellyfin"
| "/docs/integrations/emby"
| "/docs/integrations/plex"
| "/docs/integrations/jellyseerr"
| "/docs/integrations/seerr"
| "/docs/integrations/overseerr"
| "/docs/integrations/pi-hole"
| "/docs/integrations/adguard-home"
| "/docs/integrations/technitium-dns"
| "/docs/integrations/home-assistant"
| "/docs/integrations/open-media-vault"
| "/docs/integrations/dash-dot"
| "/docs/integrations/glances"
| "/docs/integrations/tdarr"
| "/docs/integrations/proxmox"
| "/docs/integrations/nextcloud"
| "/docs/integrations/unifi-controller"
| "/docs/integrations/opnsense"
| "/docs/integrations/ntfy"
| "/docs/integrations/gotify"
| "/docs/integrations/ical"
| "/docs/integrations/anchor"
| "/docs/integrations/truenas"
| "/docs/integrations/synology"
| "/docs/integrations/unraid"
| "/docs/integrations/coolify"
| "/docs/integrations/immich"
| "/docs/integrations/paperless-ngx"
| "/docs/integrations/patchmon"
| "/docs/integrations/tracearr"
| "/docs/integrations/speedtest-tracker"
| "/docs/integrations/uptime-kuma"
| "/docs/integrations/audiobookshelf"
| "/docs/integrations/navidrome"
| "/docs/integrations/umami"
| "/docs/integrations/peanut"
| "/docs/integrations/beszel"
| "/docs/integrations/gluetun"
| "/docs/integrations/traefik"
| "/docs/integrations/archiveteam-warrior"
| "/docs/integrations/wazuh"
| "/docs/integrations/whats-up-docker"
| "/docs/integrations/llama-cpp"
| "/docs/widgets/stats"
| "/docs/widgets/clock"
| "/docs/widgets/weather"
| "/docs/widgets/air-quality"
| "/docs/widgets/countdown"
| "/docs/widgets/timer"
| "/docs/widgets/app"
| "/docs/widgets/iframe"
| "/docs/widgets/video"
| "/docs/widgets/notebook"
| "/docs/widgets/anchor-note"
| "/docs/widgets/dns-hole-summary"
| "/docs/widgets/dns-hole-controls"
| "/docs/widgets/smart-home-entity-state"
| "/docs/widgets/smart-home-execute-automation"
| "/docs/widgets/stock-price"
| "/docs/widgets/media-server"
| "/docs/widgets/calendar"
| "/docs/widgets/downloads"
| "/docs/widgets/media-request-list"
| "/docs/widgets/media-request-stats"
| "/docs/widgets/media-transcoding"
| "/docs/widgets/media-missing"
| "/docs/widgets/minecraft-server-status"
| "/docs/widgets/network-controller-summary"
| "/docs/widgets/network-controller-status"
| "/docs/widgets/rss-feed"
| "/docs/widgets/bookmarks"
| "/docs/widgets/indexer-manager"
| "/docs/widgets/health-monitoring"
| "/docs/widgets/releases"
| "/docs/widgets/media-releases"
| "/docs/widgets/docker-containers"
| "/docs/widgets/firewall"
| "/docs/widgets/notifications"
| "/docs/widgets/system-resources"
| "/docs/widgets/coolify"
| "/docs/widgets/system-disks"
| "/docs/widgets/timetable"
| "/docs/widgets/immich-server-stats"
| "/docs/widgets/immich-album-carousel"
| "/docs/widgets/paperless-ngx"
| "/docs/widgets/patchmon"
| "/docs/widgets/bazarr"
| "/docs/widgets/tracearr"
| "/docs/widgets/speedtest-tracker"
| "/docs/widgets/uptime-kuma"
| "/docs/widgets/audio-stats"
| "/docs/widgets/umami"
| "/docs/widgets/vpn"
| "/docs/widgets/ups"
| "/docs/widgets/beszel-system-table"
| "/docs/widgets/beszel-system-grid"
| "/docs/widgets/beszel-alerts"
| "/docs/widgets/beszel-system-stats"
| "/docs/widgets/traefik"
| "/docs/widgets/custom-api"
| "/docs/widgets/assistant"
| "/docs/widgets/whats-up-docker"
| "/docs/widgets/llama-cpp";
| "/workshop";
+55
View File
@@ -0,0 +1,55 @@
import { XMLParser } from "fast-xml-parser";
import { z } from "zod/v4";
import { widgetDocSlugs } from "./widget-doc-slugs";
import { getIntegrationDocumentationSlug, integrationKinds } from "../integration";
const documentationOrigin = "https://homarr.dev";
export const documentationSitemapUrl = `${documentationOrigin}/sitemap.xml`;
const normalizePaths = (paths: readonly string[]) => {
const normalized = paths.map((path) => {
const url = new URL(path, documentationOrigin);
if (url.origin !== documentationOrigin || url.search || url.hash) {
throw new Error(`Invalid documentation path: ${path}`);
}
return url.pathname.replace(/\/+$/u, "");
});
return [...new Set(normalized)].toSorted();
};
export const parseDocumentationSitemap = (xml: string) => {
const data: unknown = new XMLParser({ isArray: (name) => name === "url" }).parse(xml);
const sitemap = z
.object({ urlset: z.object({ url: z.array(z.object({ loc: z.string().url() })).min(1) }) })
.parse(data);
return normalizePaths(sitemap.urlset.url.map((url) => url.loc));
};
// Both remote refresh and offline generation share normalization and slug reconciliation.
export const createDocumentationMetadata = (sitemapPaths: readonly string[]) => {
const snapshotPaths = normalizePaths(sitemapPaths);
const paths = normalizePaths([
...snapshotPaths,
"/sitemap.xml",
"/blog",
"/search",
...integrationKinds
.map(getIntegrationDocumentationSlug)
.filter((slug) => slug !== null)
.map((slug) => `/docs/integrations/${slug}`),
...Object.values(widgetDocSlugs)
.filter((slug) => slug !== null)
.map((slug) => `/docs/widgets/${slug}`),
]);
return {
snapshot: `${JSON.stringify(snapshotPaths, null, 2)}\n`,
source:
"// Generated from sitemap-paths.json and local documentation slugs.\n" +
"// Update offline with docs:generate; refresh the pinned sitemap with docs:refresh.\n" +
"export type HomarrDocumentationPath =\n" +
paths.map((path) => ` | ${JSON.stringify(path)}`).join("\n") +
";\n",
};
};
@@ -0,0 +1,284 @@
[
"",
"/about-us",
"/api-reference",
"/api-reference/apps/appRouter-all",
"/api-reference/apps/appRouter-byId",
"/api-reference/apps/appRouter-create",
"/api-reference/apps/appRouter-delete",
"/api-reference/apps/appRouter-getPaginated",
"/api-reference/apps/appRouter-search",
"/api-reference/apps/appRouter-selectable",
"/api-reference/apps/appRouter-update",
"/api-reference/boards/boardRouter-addItem",
"/api-reference/boards/boardRouter-changeBoardVisibility",
"/api-reference/boards/boardRouter-createBoard",
"/api-reference/boards/boardRouter-deleteBoard",
"/api-reference/boards/boardRouter-duplicateBoard",
"/api-reference/boards/boardRouter-getAllBoards",
"/api-reference/boards/boardRouter-renameBoard",
"/api-reference/boards/boardRouter-savePartialBoardSettings",
"/api-reference/boards/boardRouter-setHomeBoard",
"/api-reference/boards/boardRouter-setMobileHomeBoard",
"/api-reference/boards/boardRouter-updateItemLayout",
"/api-reference/info/infoRouter-getInfo",
"/api-reference/integrations/integration-request",
"/api-reference/invites/inviteRouter-createInvite",
"/api-reference/invites/inviteRouter-deleteInvite",
"/api-reference/invites/inviteRouter-getAll",
"/api-reference/settings/serverSettingsRouter-getBoardSettings",
"/api-reference/settings/serverSettingsRouter-updateBoardSettings",
"/api-reference/users/userRouter-changeColorScheme",
"/api-reference/users/userRouter-changeDdgBangs",
"/api-reference/users/userRouter-changeDefaultSearchEngine",
"/api-reference/users/userRouter-changeEnableRightClickOnWidgets",
"/api-reference/users/userRouter-changeFirstDayOfWeek",
"/api-reference/users/userRouter-changeHeaderPreferences",
"/api-reference/users/userRouter-changeHomeBoards",
"/api-reference/users/userRouter-changePassword",
"/api-reference/users/userRouter-changeSearchPreferences",
"/api-reference/users/userRouter-create",
"/api-reference/users/userRouter-delete",
"/api-reference/users/userRouter-editProfile",
"/api-reference/users/userRouter-getAll",
"/api-reference/users/userRouter-getById",
"/api-reference/users/userRouter-search",
"/api-reference/users/userRouter-selectable",
"/api-reference/users/userRouter-setProfileImage",
"/blog/2023/01/11/version0.11",
"/blog/2023/04/16/version0.12-more-widgets",
"/blog/2023/11/10/authentication",
"/blog/2023/12/22/updated-documentation",
"/blog/2024/09/23/version-1.0",
"/blog/2024/12/17/open-beta-1.0",
"/blog/2025/01/19/migration-guide-1.0",
"/blog/2025/08/02/using-argus",
"/blog/2026/09/03/homarr-2.0",
"/blog/documentation-migration",
"/blog/translations",
"/docs",
"/docs/advanced",
"/docs/advanced/command-line",
"/docs/advanced/command-line/development",
"/docs/advanced/command-line/fix-usernames",
"/docs/advanced/command-line/integrations",
"/docs/advanced/command-line/password-recovery",
"/docs/advanced/command-line/users",
"/docs/advanced/development/getting-started",
"/docs/advanced/development/kubernetes",
"/docs/advanced/development/widgets-and-integrations",
"/docs/advanced/development/workshop",
"/docs/advanced/development/workshop-operator",
"/docs/advanced/environment-variables",
"/docs/advanced/icons",
"/docs/advanced/keyboard-shortcuts",
"/docs/advanced/mysql-to-sqlite",
"/docs/advanced/proxy",
"/docs/advanced/running-as-different-user",
"/docs/advanced/single-sign-on",
"/docs/advanced/styling",
"/docs/community",
"/docs/community/donate",
"/docs/community/faq",
"/docs/community/get-in-touch",
"/docs/community/license",
"/docs/community/translations",
"/docs/getting-started",
"/docs/getting-started/after-the-installation",
"/docs/getting-started/glossary",
"/docs/getting-started/installation",
"/docs/getting-started/installation/docker",
"/docs/getting-started/installation/easy-panel",
"/docs/getting-started/installation/helm",
"/docs/getting-started/installation/home-assistant",
"/docs/getting-started/installation/hostinger",
"/docs/getting-started/installation/pika-pods",
"/docs/getting-started/installation/portainer",
"/docs/getting-started/installation/proxmox",
"/docs/getting-started/installation/qnap",
"/docs/getting-started/installation/railway",
"/docs/getting-started/installation/runtipi",
"/docs/getting-started/installation/saltbox",
"/docs/getting-started/installation/source",
"/docs/getting-started/installation/synology",
"/docs/getting-started/installation/unraid",
"/docs/integrations",
"/docs/integrations/adguard-home",
"/docs/integrations/anchor",
"/docs/integrations/archiveteam-warrior",
"/docs/integrations/aria2",
"/docs/integrations/audiobookshelf",
"/docs/integrations/autobrr",
"/docs/integrations/bazarr",
"/docs/integrations/beszel",
"/docs/integrations/bindery",
"/docs/integrations/caddy",
"/docs/integrations/changedetection",
"/docs/integrations/coolify",
"/docs/integrations/dash-dot",
"/docs/integrations/deluge",
"/docs/integrations/docker",
"/docs/integrations/docker-labels",
"/docs/integrations/emby",
"/docs/integrations/fileflows",
"/docs/integrations/frigate",
"/docs/integrations/gatus",
"/docs/integrations/glances",
"/docs/integrations/gluetun",
"/docs/integrations/gotify",
"/docs/integrations/healthchecks",
"/docs/integrations/home-assistant",
"/docs/integrations/homebox",
"/docs/integrations/ical",
"/docs/integrations/immich",
"/docs/integrations/jackett",
"/docs/integrations/jellyfin",
"/docs/integrations/jellyseerr",
"/docs/integrations/jellystat",
"/docs/integrations/karakeep",
"/docs/integrations/komga",
"/docs/integrations/kubernetes",
"/docs/integrations/lidarr",
"/docs/integrations/linkwarden",
"/docs/integrations/llama-cpp",
"/docs/integrations/maintainerr",
"/docs/integrations/mealie",
"/docs/integrations/miniflux",
"/docs/integrations/navidrome",
"/docs/integrations/netalertx",
"/docs/integrations/netdata",
"/docs/integrations/nextcloud",
"/docs/integrations/ntfy",
"/docs/integrations/nzbget",
"/docs/integrations/open-media-vault",
"/docs/integrations/opnsense",
"/docs/integrations/overseerr",
"/docs/integrations/paperless-ngx",
"/docs/integrations/patchmon",
"/docs/integrations/peanut",
"/docs/integrations/pi-hole",
"/docs/integrations/plantit",
"/docs/integrations/plex",
"/docs/integrations/prometheus",
"/docs/integrations/prowlarr",
"/docs/integrations/proxmox",
"/docs/integrations/q-bittorent",
"/docs/integrations/radarr",
"/docs/integrations/readarr",
"/docs/integrations/romm",
"/docs/integrations/sabnzbd",
"/docs/integrations/scrutiny",
"/docs/integrations/seerr",
"/docs/integrations/slskd",
"/docs/integrations/sonarr",
"/docs/integrations/speedtest-tracker",
"/docs/integrations/spoolman",
"/docs/integrations/stash",
"/docs/integrations/syncthing-relay",
"/docs/integrations/synology",
"/docs/integrations/tandoor",
"/docs/integrations/tdarr",
"/docs/integrations/technitium-dns",
"/docs/integrations/tracearr",
"/docs/integrations/traefik",
"/docs/integrations/transmission",
"/docs/integrations/trilium",
"/docs/integrations/truenas",
"/docs/integrations/tubearchivist",
"/docs/integrations/umami",
"/docs/integrations/unifi-controller",
"/docs/integrations/unmanic",
"/docs/integrations/unraid",
"/docs/integrations/uptime-kuma",
"/docs/integrations/wazuh",
"/docs/integrations/whats-up-docker",
"/docs/integrations/xteve",
"/docs/integrations/your-spotify",
"/docs/management",
"/docs/management/api",
"/docs/management/apps",
"/docs/management/assistant",
"/docs/management/backup",
"/docs/management/boards",
"/docs/management/certificates",
"/docs/management/custom-widgets",
"/docs/management/custom-widgets/agent-authoring",
"/docs/management/custom-widgets/authoring",
"/docs/management/custom-widgets/component-reference",
"/docs/management/custom-widgets/custom-jsx",
"/docs/management/custom-widgets/requests-and-security",
"/docs/management/custom-widgets/troubleshooting",
"/docs/management/integrations",
"/docs/management/logs",
"/docs/management/mcp",
"/docs/management/media",
"/docs/management/search-engines",
"/docs/management/settings",
"/docs/management/tasks",
"/docs/management/users",
"/docs/widgets",
"/docs/widgets/air-quality",
"/docs/widgets/anchor-note",
"/docs/widgets/app",
"/docs/widgets/archive-team-warrior",
"/docs/widgets/assistant",
"/docs/widgets/audio-stats",
"/docs/widgets/bazarr",
"/docs/widgets/beszel-alerts",
"/docs/widgets/beszel-system-grid",
"/docs/widgets/beszel-system-stats",
"/docs/widgets/beszel-system-table",
"/docs/widgets/bookmarks",
"/docs/widgets/calendar",
"/docs/widgets/clock",
"/docs/widgets/coolify",
"/docs/widgets/countdown",
"/docs/widgets/custom-api",
"/docs/widgets/dns-hole-controls",
"/docs/widgets/dns-hole-summary",
"/docs/widgets/docker-containers",
"/docs/widgets/downloads",
"/docs/widgets/firewall",
"/docs/widgets/health-monitoring",
"/docs/widgets/iframe",
"/docs/widgets/immich-album-carousel",
"/docs/widgets/immich-server-stats",
"/docs/widgets/indexer-manager",
"/docs/widgets/llama-cpp",
"/docs/widgets/media-missing",
"/docs/widgets/media-releases",
"/docs/widgets/media-request-list",
"/docs/widgets/media-request-stats",
"/docs/widgets/media-server",
"/docs/widgets/media-transcoding",
"/docs/widgets/minecraft-server-status",
"/docs/widgets/network-controller-status",
"/docs/widgets/network-controller-summary",
"/docs/widgets/notebook",
"/docs/widgets/notifications",
"/docs/widgets/paperless-ngx",
"/docs/widgets/patchmon",
"/docs/widgets/releases",
"/docs/widgets/rss-feed",
"/docs/widgets/smart-home-entity-state",
"/docs/widgets/smart-home-execute-automation",
"/docs/widgets/speedtest-tracker",
"/docs/widgets/stats",
"/docs/widgets/stock-price",
"/docs/widgets/system-disks",
"/docs/widgets/system-resources",
"/docs/widgets/timer",
"/docs/widgets/timetable",
"/docs/widgets/tracearr",
"/docs/widgets/traefik",
"/docs/widgets/umami",
"/docs/widgets/ups",
"/docs/widgets/uptime-kuma",
"/docs/widgets/video",
"/docs/widgets/vpn",
"/docs/widgets/weather",
"/docs/widgets/whats-up-docker",
"/docs/workshop",
"/docs/workshop/homarr-provider",
"/workshop"
]