diff --git a/.gitignore b/.gitignore
index d446ca981..881a5f0fa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,7 @@
# dependencies
node_modules
+.pnpm-store/
.pnp
.pnp.js
.idea/
@@ -70,6 +71,8 @@ apps/nextjs/public/images/background.png
# personal agent config
.opencode
+.agents/
+skills-lock.json
# docusaurus
apps/docs/.docusaurus
diff --git a/CHANGES.md b/CHANGES.md
new file mode 100644
index 000000000..c8a801420
--- /dev/null
+++ b/CHANGES.md
@@ -0,0 +1,96 @@
+# Changes
+
+## Goal
+
+Remove widget-only services from Homarr's global Integration system.
+
+The affected services are release providers and Search.ch. They are only used by specific widgets, so keeping them as global integrations added unnecessary setup, UI, database rows, docs pages, and integration package code.
+
+ArchiveTeam Warrior remains a proper integration but is no longer auto-seeded on first install.
+
+## Why
+
+These services do not need shared integration state.
+
+- Release providers are selected per Releases widget repository.
+- Search.ch is only used by the Timetable widget.
+
+Moving them into widget options makes configuration simpler and removes dead-weight integration code from `packages/integrations`.
+
+## What Changed
+
+### Release Providers
+
+- Added release provider definitions in `packages/definitions/src/release-provider.ts`.
+- Removed release providers from `IntegrationKind`.
+- Moved release-fetching code out of `packages/integrations` and into `packages/request-handler/src/release-providers.ts`.
+- Updated the Releases widget to store provider configuration directly in widget options:
+ - `provider`
+ - `identifier`
+ - `versionFilter`
+ - `providerUrl`
+- Updated the Releases widget editor to use a provider select instead of an integration select.
+- Updated Docker import mapping so `ghcr.io` maps to `gitHubContainerRegistry`.
+- GitHub Container Registry now uses the public OCI registry API and accepts full image references such as `ghcr.io/homarr-labs/homarr:latest`.
+
+### Timetable / Search.ch
+
+- Removed Search.ch as an integration.
+- Added a Timetable widget `baseUrl` option, defaulting to `https://search.ch`.
+- Moved Search.ch request/parsing logic into `packages/request-handler/src/timetable.ts`.
+- Updated the Timetable API to receive `baseUrl` directly from widget options.
+
+### ArchiveTeam Warrior
+
+- Kept as a proper integration (not removed).
+- Removed `defaultUrl` from the integration definition to prevent auto-seeding on first install.
+
+### Integration Cleanup
+
+- Removed creators, exports, docs references, and implementation files for the deleted integrations.
+- Removed unused dependencies from `packages/integrations/package.json`.
+
+### Database Migration
+
+- Added `packages/db/migrations/custom/0003_remove_widget_only_integrations.ts`.
+- The migration moves old integration-linked widget config into widget options, then deletes the old widget-only integration rows.
+- Updated the earlier release widget migration to use the new `provider` field instead of `providerIntegrationId`.
+
+### Docs
+
+- Updated Releases widget docs to describe providers instead of integrations.
+- Updated Timetable docs to remove Search.ch integration setup.
+- Removed obsolete integration docs pages for the deleted integration kinds.
+- Updated docs sitemap and integration docs mappings.
+
+### Translations
+
+- Added English labels for the new widget options:
+ - `widget.timetable.option.baseUrl.label`
+ - `widget.releases.option.repositories.providerUrl.label`
+
+## How It Works Now
+
+Release provider configuration lives on each Releases widget repository entry. The request handler resolves provider metadata and fetches releases directly from the provider-specific endpoint. GHCR uses anonymous OCI registry access for public packages.
+
+Timetable passes its widget URL option directly to its API router and request handler. No global integration lookup is needed.
+
+ArchiveTeam Warrior continues to use the standard integration system, but users must manually add the integration (it is not auto-created on install).
+
+## Deliberate Non-Goals
+
+- No provider secret/token support was added.
+- No new secret storage model was introduced.
+- No compatibility layer was kept in `packages/integrations`.
+
+Widget options are client-visible, so storing provider credentials there would be wrong. If authenticated provider requests are needed later, they need a separate secret-storage design.
+
+## Verification So Far
+
+- Focused typechecks passed for affected packages.
+- Full `pnpm turbo typecheck` passed.
+- Full `pnpm lint` passed with existing warnings.
+- Focused release provider normalization tests passed.
+- Widget translation test passed.
+- Live GHCR smoke checks passed for `ghcr.io/muchobien/pocketbase:latest` and `ghcr.io/homarr-labs/homarr:latest`.
+- `pnpm test packages/integrations/test/pi-hole.spec.ts` passed earlier, but failed on rebased reruns because Pi-hole reported `domainsBeingBlocked` as `-2`/`0` instead of `> 1`.
diff --git a/apps/docs/docs/getting-started/after-the-installation.mdx b/apps/docs/docs/getting-started/after-the-installation.mdx
index 5f923cec8..7ac904bf4 100644
--- a/apps/docs/docs/getting-started/after-the-installation.mdx
+++ b/apps/docs/docs/getting-started/after-the-installation.mdx
@@ -28,6 +28,7 @@ Read our [glossary](/docs/getting-started/glossary) if you are new to Homarr.
Congratulations on installing Homarr. Now it's time to get yourself familiar with the concepts of Homarr and how to use it.
## Onboarding
+
The onboard will show the first time you start Homarr.
This process will help you with your first steps and adding some initial data, such as the administrator account.
@@ -45,50 +46,68 @@ You can either import a previous dashboard using the ZIP archive or start from s
You may refresh anytime and continue from a different device - the onboarding is saved immediately on the server for your convenience.
### Starting from scratch
-Depending on your auth provider configuration you will either first see the admin user creation form or the external group creation form.
-If credentials provider was selected, you'll be prompted to create an admin user for Homarr.
-This user cannot be deleted and has full control over Homarr and all of it's boards.
-You must choose an username and password (both can later be changed).
-We enforce strict password requirements, when you enter your password, to protect your instance if you accidentially
-expose it to the Internet.
-
+
-### Supported Integrations
+### Supported Providers
-
+GitHub, Docker Hub, GitLab, NPM, Codeberg, GitHub Container Registry, Quay, and LinuxServer.io are configured per repository in the widget.
+
+For GitHub Container Registry, use `owner/package` identifiers such as `homarr-labs/homarr`.
+Full image references such as `ghcr.io/homarr-labs/homarr:latest` are also accepted.
### Adding the widget
### Configuration
+
:::note
@@ -74,4 +49,3 @@ Setting the Prefix to `v`, precision to `2` and the Suffix to `-alpha`, will mat
Setting the Prefix to `v`, precision to `3`, will match `v5.2.0` but not `v1.0.2-alpha` or `Beta v5.2.1`.
:::
-
diff --git a/apps/docs/docs/widgets/releases/index.ts b/apps/docs/docs/widgets/releases/index.ts
index dbe3c1271..1f2270e82 100644
--- a/apps/docs/docs/widgets/releases/index.ts
+++ b/apps/docs/docs/widgets/releases/index.ts
@@ -54,16 +54,23 @@ export const releasesWidget: WidgetDefinition = {
items: [
{
name: "Provider",
- description: "Integration to fetch the repository from.",
- values: "Select from the available integrations.",
+ description: "Provider to fetch the repository or package releases from.",
+ values: "Select from the available providers.",
defaultValue: "-",
},
{
name: "Identifier",
- description: 'The identifier of the repository, e.g. "homarr-labs/homarr".',
- values: "Any valid repository identifier.",
+ description: 'The identifier of the repository or package, e.g. "homarr-labs/homarr".',
+ values:
+ 'Any valid provider identifier. GHCR also accepts full image refs like "ghcr.io/owner/package:tag".',
defaultValue: "-",
},
+ {
+ name: "Provider URL",
+ description: "Base URL for the provider.",
+ values: "Any valid URL.",
+ defaultValue: "Provider default",
+ },
{
name: "Name",
description: "Display name of the repository.",
diff --git a/apps/docs/docs/widgets/timetable/index.mdx b/apps/docs/docs/widgets/timetable/index.mdx
index fe9a1b11c..e9bdfd326 100644
--- a/apps/docs/docs/widgets/timetable/index.mdx
+++ b/apps/docs/docs/widgets/timetable/index.mdx
@@ -1,44 +1,40 @@
---
-title: 'Timetable'
-description: 'Displays departure times for a station.'
+title: "Timetable"
+description: "Displays departure times for a station."
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 { WidgetIntegrations } from '@site/src/components/widgets/integrations';
-import { timetableWidget } from '.';
-import { searchChIntegration } from '@site/docs/integrations/search-ch';
+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 { timetableWidget } from ".";
-
-
+
The Timetable widget provides real-time departure times for a selected station.
### Screenshots
-import trainDepartures from './img/train-departures.png';
-import streetDepartures from './img/street-departures.png';
+import trainDepartures from "./img/train-departures.png";
+import streetDepartures from "./img/street-departures.png";
### Adding the widget
-### Supported Integrations
-
-
-
### Configuration
+
diff --git a/apps/docs/docs/widgets/timetable/index.ts b/apps/docs/docs/widgets/timetable/index.ts
index 6f36349ee..1cefb6bcd 100644
--- a/apps/docs/docs/widgets/timetable/index.ts
+++ b/apps/docs/docs/widgets/timetable/index.ts
@@ -8,6 +8,12 @@ export const timetableWidget: WidgetDefinition = {
path: "../../widgets/timetable",
configuration: {
items: [
+ {
+ name: "Search.ch URL",
+ description: "Base URL for the Search.ch timetable API.",
+ values: "Any valid URL.",
+ defaultValue: "https://search.ch",
+ },
{
name: "Station",
description: "Select the station",
diff --git a/apps/nextjs/src/components/board/items/item-menu.tsx b/apps/nextjs/src/components/board/items/item-menu.tsx
index 1c0c4100a..b8a136bbb 100644
--- a/apps/nextjs/src/components/board/items/item-menu.tsx
+++ b/apps/nextjs/src/components/board/items/item-menu.tsx
@@ -85,6 +85,7 @@ const BoardItemMenuInner = ({ offset, item, resetErrorBoundary }: BoardItemMenuP
),
integrationSupport: "supportedIntegrations" in currentDefinition,
settings,
+ itemId: item.id,
appId: item.kind === "app" ? (item.options.appId as string | undefined) : undefined,
},
{
diff --git a/apps/nextjs/src/components/integration/integration-grid-shared.ts b/apps/nextjs/src/components/integration/integration-grid-shared.ts
index 2fc7228c8..7451af1e7 100644
--- a/apps/nextjs/src/components/integration/integration-grid-shared.ts
+++ b/apps/nextjs/src/components/integration/integration-grid-shared.ts
@@ -48,10 +48,8 @@ export const categoryTranslationKeys: Record
= {
search: "integration.category.search",
mediaTranscoding: "integration.category.mediaTranscoding",
networkController: "integration.category.networkController",
- releasesProvider: "integration.category.releasesProvider",
notifications: "integration.category.notifications",
firewall: "integration.category.firewall",
- timetable: "integration.category.timetable",
photoService: "integration.category.photoService",
notes: "integration.category.notes",
mediaMonitoring: "integration.category.mediaMonitoring",
diff --git a/docs/README.md b/docs/README.md
index 8e37dfdc6..99aa947bf 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -102,20 +102,13 @@
-
- Codeberg
-
-
-
Coolify
-
-
+
-
- Docker
-
-
-
-
- Github
-
-
-
-
- GitHub
-
-
-
- Gitlab
-
-
-
+
+ Gluetun
+
+
+
Home
-
-
+
Jellyfin
-
+
+
-
- LinuxServer.io
-
-
-
Nextcloud
-
-
-
- NPM
-
-
-
+
ntfy
-
+
+
PeaNUT
-
-
+
Pi-hole
-
+
+
-
- Quay
-
-
-
-
- Search.ch
-
-
-
Tdarr
-
+
+
Technitium
-
-
+
Unraid
-
+
+
| undefined) => {
if (!versionFilter) return undefined;
@@ -28,45 +29,83 @@ const releaseVersionFilterSchema = z.object({
export const releasesRouter = createTRPCRouter({
getLatest: publicProcedure
- .concat(createOneIntegrationMiddleware("query", ...getIntegrationKindsByCategory("releasesProvider")))
.input(
z.object({
+ itemId: z.string().optional(),
repositories: z.array(
z.object({
- id: z.string(),
+ id: z.string().optional(),
+ provider: z.enum(releaseProviderKinds),
identifier: z.string(),
versionFilter: releaseVersionFilterSchema.optional(),
+ providerUrl: z.string().url().optional(),
}),
),
}),
)
.query(async ({ ctx, input }) => {
- const settled = await Promise.allSettled(
- input.repositories.map(async (repository) => {
- const response = await releasesRequestHandler
- .handler(ctx.integration, {
- id: repository.id,
- identifier: repository.identifier,
- versionRegex: formatVersionFilterRegex(repository.versionFilter),
- })
- .getDataAsync();
+ const tokensByProvider = new Map();
+ let allowedRepoIds: Set | null = null;
- return {
- id: repository.id,
- integration: { name: ctx.integration.name, kind: ctx.integration.kind },
- timestamp: response.timestamp,
- ...response.data,
- };
+ if (input.itemId) {
+ try {
+ const item = await ctx.db.query.items.findFirst({ where: eq(items.id, input.itemId) });
+ if (item && item.kind === "releases") {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, item.boardId), "view");
+
+ const options = SuperJSON.parse>(item.options);
+ const repos = options.repositories as Array<{ id?: string }> | undefined;
+ if (repos) {
+ allowedRepoIds = new Set(repos.map((r) => r.id).filter((id): id is string => Boolean(id)));
+ }
+
+ const secrets = await ctx.db.query.widgetSecrets.findMany({
+ where: eq(widgetSecrets.itemId, input.itemId),
+ });
+ for (const secret of secrets) {
+ try {
+ tokensByProvider.set(secret.kind, decryptSecret(secret.value));
+ } catch {
+ // Skip corrupt secrets
+ }
+ }
+ }
+ } catch {
+ // Access denied or table not yet migrated -- proceed without tokens
+ }
+ }
+
+ return await Promise.all(
+ input.repositories.map(async (repository) => {
+ try {
+ const useToken = allowedRepoIds === null || allowedRepoIds.has(repository.id);
+ const response = await releasesRequestHandler
+ .handler({
+ id: repository.id,
+ provider: repository.provider,
+ identifier: repository.identifier,
+ versionRegex: formatVersionFilterRegex(repository.versionFilter),
+ providerUrl: repository.providerUrl,
+ token: useToken ? tokensByProvider.get(repository.provider) : undefined,
+ })
+ .getDataAsync();
+
+ return {
+ id: repository.id,
+ provider: repository.provider,
+ timestamp: response.timestamp,
+ ...response.data,
+ };
+ } catch (error) {
+ return {
+ id: repository.id,
+ provider: repository.provider,
+ timestamp: new Date(),
+ success: false as const,
+ error: { code: "unexpected" as const, message: String(error) },
+ };
+ }
}),
);
-
- return settled.flatMap((result, index) => {
- if (result.status === "fulfilled") return [result.value];
- logger.warn("Release fetch failed", {
- repository: input.repositories[index]?.identifier,
- error: result.reason,
- });
- return [];
- });
}),
});
diff --git a/packages/api/src/router/widgets/timetable.ts b/packages/api/src/router/widgets/timetable.ts
index c33496cdc..d04fa71bd 100644
--- a/packages/api/src/router/widgets/timetable.ts
+++ b/packages/api/src/router/widgets/timetable.ts
@@ -1,21 +1,26 @@
import z from "zod";
-import { getIntegrationKindsByCategory } from "@homarr/definitions";
-import { timetableOptionsSchema } from "@homarr/integrations/types";
import {
timetableGetTimetableRequestHandler,
timetableSearchStationsRequestHandler,
} from "@homarr/request-handler/timetable";
-import { createOneIntegrationMiddleware } from "../../middlewares/integration";
import { createTRPCRouter, publicProcedure } from "../../trpc";
+const baseUrlSchema = z.string().url();
+
export const timetableRouter = createTRPCRouter({
getTimetable: publicProcedure
- .concat(createOneIntegrationMiddleware("query", ...getIntegrationKindsByCategory("timetable")))
- .input(timetableOptionsSchema)
- .query(async ({ input, ctx }) => {
- const innerHandler = timetableGetTimetableRequestHandler.handler(ctx.integration, {
+ .input(
+ z.object({
+ baseUrl: baseUrlSchema,
+ stationId: z.string(),
+ limit: z.number().int().min(1).max(100),
+ }),
+ )
+ .query(async ({ input }) => {
+ const innerHandler = timetableGetTimetableRequestHandler.handler({
+ baseUrl: input.baseUrl,
stationId: input.stationId,
limit: input.limit,
});
@@ -25,14 +30,15 @@ export const timetableRouter = createTRPCRouter({
return data;
}),
searchStations: publicProcedure
- .concat(createOneIntegrationMiddleware("query", ...getIntegrationKindsByCategory("timetable")))
.input(
z.object({
+ baseUrl: baseUrlSchema,
query: z.string(),
}),
)
- .query(async ({ input, ctx }) => {
- const innerHandler = timetableSearchStationsRequestHandler.handler(ctx.integration, {
+ .query(async ({ input }) => {
+ const innerHandler = timetableSearchStationsRequestHandler.handler({
+ baseUrl: input.baseUrl,
query: input.query,
});
diff --git a/packages/api/src/router/widgets/widget-secrets.ts b/packages/api/src/router/widgets/widget-secrets.ts
new file mode 100644
index 000000000..75ae23cca
--- /dev/null
+++ b/packages/api/src/router/widgets/widget-secrets.ts
@@ -0,0 +1,97 @@
+import { TRPCError } from "@trpc/server";
+import { z } from "zod/v4";
+
+import { encryptSecret } from "@homarr/common/server";
+import { and, eq, handleTransactionsAsync } from "@homarr/db";
+import { boards, items, widgetSecrets } from "@homarr/db/schema";
+import { releaseProviderKinds } from "@homarr/definitions";
+
+import { createTRPCRouter, protectedProcedure } from "../../trpc";
+import { throwIfActionForbiddenAsync } from "../board/board-access";
+
+const secretKindSchema = z.enum(releaseProviderKinds);
+
+const resolveItemWithBoardAccess = async (ctx: { db: any; session: any }, itemId: string) => {
+ const item = await ctx.db.query.items.findFirst({ where: eq(items.id, itemId) });
+ if (!item || item.kind !== "releases") throw new TRPCError({ code: "NOT_FOUND" });
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, item.boardId), "modify");
+ return item;
+};
+
+export const widgetSecretsRouter = createTRPCRouter({
+ setSecret: protectedProcedure
+ .meta({
+ mcp: {
+ enabled: true,
+ description:
+ "Set an authentication token for a release provider on a specific releases widget. Requires modify permission on the widget's board. Use widget_secrets_getConfiguredKinds to check existing tokens",
+ },
+ })
+ .input(z.object({ itemId: z.string(), kind: secretKindSchema, value: z.string().min(1).max(4096) }))
+ .mutation(async ({ ctx, input }) => {
+ await resolveItemWithBoardAccess(ctx, input.itemId);
+
+ const encrypted = encryptSecret(input.value);
+ const row = { itemId: input.itemId, kind: input.kind, value: encrypted, updatedAt: new Date() };
+
+ await handleTransactionsAsync(ctx.db, {
+ async handleAsync(db, schema) {
+ await db.transaction(async (tx) => {
+ await tx
+ .delete(schema.widgetSecrets)
+ .where(and(eq(schema.widgetSecrets.itemId, input.itemId), eq(schema.widgetSecrets.kind, input.kind)));
+ await tx.insert(schema.widgetSecrets).values(row);
+ });
+ },
+ handleSync(db) {
+ db.transaction((tx) => {
+ tx.delete(widgetSecrets)
+ .where(and(eq(widgetSecrets.itemId, input.itemId), eq(widgetSecrets.kind, input.kind)))
+ .run();
+ tx.insert(widgetSecrets).values(row).run();
+ });
+ },
+ });
+ }),
+
+ deleteSecret: protectedProcedure
+ .meta({
+ mcp: {
+ enabled: true,
+ description:
+ "Remove an authentication token for a release provider from a specific releases widget. Requires modify permission on the widget's board",
+ },
+ })
+ .input(z.object({ itemId: z.string(), kind: secretKindSchema }))
+ .mutation(async ({ ctx, input }) => {
+ await resolveItemWithBoardAccess(ctx, input.itemId);
+
+ await ctx.db
+ .delete(widgetSecrets)
+ .where(and(eq(widgetSecrets.itemId, input.itemId), eq(widgetSecrets.kind, input.kind)));
+ }),
+
+ getConfiguredKinds: protectedProcedure
+ .meta({
+ mcp: {
+ enabled: true,
+ description:
+ "List which release provider kinds have tokens configured for a releases widget. Returns an array of provider kind strings (e.g. github, gitlab, dockerHub). Requires modify permission on the widget's board",
+ },
+ })
+ .input(z.object({ itemId: z.string() }))
+ .query(async ({ ctx, input }) => {
+ await resolveItemWithBoardAccess(ctx, input.itemId);
+
+ try {
+ const secrets = await ctx.db.query.widgetSecrets.findMany({
+ where: eq(widgetSecrets.itemId, input.itemId),
+ columns: { kind: true },
+ });
+ return secrets.map((s: { kind: string }) => s.kind);
+ } catch {
+ // ponytail: table may not exist pre-migration, return empty
+ return [] as string[];
+ }
+ }),
+});
diff --git a/packages/db/migrations/custom/0000_release_widget_provider_to_options.ts b/packages/db/migrations/custom/0000_release_widget_provider_to_options.ts
index 951831482..85f39bcbc 100644
--- a/packages/db/migrations/custom/0000_release_widget_provider_to_options.ts
+++ b/packages/db/migrations/custom/0000_release_widget_provider_to_options.ts
@@ -1,8 +1,7 @@
import SuperJSON from "superjson";
import { createId } from "@homarr/common";
-import type { IntegrationKind } from "@homarr/definitions";
-import { getIntegrationKindsByCategory } from "@homarr/definitions";
+import { releaseProviderKinds } from "@homarr/definitions";
import { eq } from "../..";
import type { Database } from "../..";
@@ -13,19 +12,6 @@ export async function migrateReleaseWidgetProviderToOptionsAsync(db: Database) {
where: (items, { eq }) => eq(items.kind, "releases"),
});
- const integrationKinds = getIntegrationKindsByCategory("releasesProvider");
- const providerIntegrations = await db.query.integrations.findMany({
- where: (integrations, { inArray }) => inArray(integrations.kind, integrationKinds),
- columns: {
- id: true,
- kind: true,
- },
- });
-
- const providerIntegrationMap = new Map(
- providerIntegrations.map((integration) => [integration.kind, integration.id]),
- );
-
const updates: {
id: string;
options: object;
@@ -37,18 +23,19 @@ export async function migrateReleaseWidgetProviderToOptionsAsync(db: Database) {
if (options.repositories.length === 0) continue;
if (!options.repositories.some((repository) => "providerKey" in repository)) continue;
- const updatedRepositories = options.repositories.map(
- ({ providerKey, ...otherFields }: { providerKey: string; [key: string]: unknown }) => {
- // Ensure providerKey is camelCase
+ const updatedRepositories = options.repositories
+ .map(({ providerKey, ...otherFields }: { providerKey: string; [key: string]: unknown }) => {
const provider = providerKey.charAt(0).toLowerCase() + providerKey.slice(1);
+ const matchedProvider = releaseProviderKinds.find((kind) => kind === provider);
+ if (!matchedProvider) return null;
return {
id: createId(),
- providerIntegrationId: providerIntegrationMap.get(provider as IntegrationKind) ?? null,
+ provider: matchedProvider,
...otherFields,
};
- },
- );
+ })
+ .filter((repo) => repo !== null);
updates.push({
id: item.id,
@@ -68,5 +55,5 @@ export async function migrateReleaseWidgetProviderToOptionsAsync(db: Database) {
.where(eq(items.id, update.id));
}
- console.log(`Migrated release widget providers to integrations count="${updates.length}"`);
+ console.log(`Migrated release widget providers to options count="${updates.length}"`);
}
diff --git a/packages/db/migrations/custom/0003_remove_widget_only_integrations.ts b/packages/db/migrations/custom/0003_remove_widget_only_integrations.ts
new file mode 100644
index 000000000..0c7a04d6c
--- /dev/null
+++ b/packages/db/migrations/custom/0003_remove_widget_only_integrations.ts
@@ -0,0 +1,100 @@
+import SuperJSON from "superjson";
+
+import { eq, inArray } from "../..";
+import type { Database } from "../..";
+import { integrationItems, integrations, items } from "../../schema";
+
+const removedIntegrationKinds = [
+ "github",
+ "dockerHub",
+ "gitlab",
+ "npm",
+ "codeberg",
+ "linuxServerIO",
+ "gitHubContainerRegistry",
+ "quay",
+ "searchCh",
+] as const;
+
+type RemovedIntegrationKind = (typeof removedIntegrationKinds)[number];
+
+const releaseProviderKinds = [
+ "github",
+ "dockerHub",
+ "gitlab",
+ "npm",
+ "codeberg",
+ "linuxServerIO",
+ "gitHubContainerRegistry",
+ "quay",
+] as const;
+
+const isReleaseProviderKind = (kind: RemovedIntegrationKind): kind is (typeof releaseProviderKinds)[number] =>
+ releaseProviderKinds.some((provider) => provider === kind);
+
+export async function migrateWidgetOnlyIntegrationsToOptionsAsync(db: Database) {
+ const oldIntegrations = await db.query.integrations.findMany({
+ columns: { id: true, kind: true, url: true },
+ });
+ const oldIntegrationById = new Map(
+ oldIntegrations
+ .filter((integration) => removedIntegrationKinds.includes(integration.kind as RemovedIntegrationKind))
+ .map((integration) => [
+ integration.id,
+ { kind: integration.kind as RemovedIntegrationKind, url: integration.url },
+ ]),
+ );
+
+ if (oldIntegrationById.size === 0) return;
+
+ const oldIntegrationIds = Array.from(oldIntegrationById.keys());
+ const oldIntegrationItems = await db.query.integrationItems.findMany();
+ const oldIntegrationItemByItemId = new Map(
+ oldIntegrationItems
+ .filter((item) => oldIntegrationById.has(item.integrationId))
+ .map((item) => [item.itemId, oldIntegrationById.get(item.integrationId)]),
+ );
+ const existingItems = await db.query.items.findMany({
+ where: (items, { inArray }) => inArray(items.kind, ["releases", "timetable"]),
+ });
+
+ const updatedItems: { id: string; options: object }[] = [];
+
+ for (const item of existingItems) {
+ const options = SuperJSON.parse>(item.options);
+ const linkedIntegration = oldIntegrationItemByItemId.get(item.id);
+
+ if (item.kind === "releases" && Array.isArray(options.repositories)) {
+ const repositories = options.repositories.map((repository) => {
+ if (typeof repository !== "object" || repository === null) return repository;
+ const { providerIntegrationId, ...rest } = repository as Record;
+ const provider =
+ typeof providerIntegrationId === "string" ? oldIntegrationById.get(providerIntegrationId) : undefined;
+ const existingProviderUrl =
+ typeof rest.providerUrl === "string" && rest.providerUrl.length > 0 ? rest.providerUrl : undefined;
+ return {
+ ...rest,
+ provider: provider && isReleaseProviderKind(provider.kind) ? provider.kind : rest.provider,
+ providerUrl: provider?.url ?? existingProviderUrl,
+ };
+ });
+ updatedItems.push({ id: item.id, options: { ...options, repositories } });
+ }
+
+ if (item.kind === "timetable" && linkedIntegration?.kind === "searchCh") {
+ updatedItems.push({ id: item.id, options: { ...options, baseUrl: linkedIntegration.url } });
+ }
+ }
+
+ for (const update of updatedItems) {
+ await db
+ .update(items)
+ .set({ options: SuperJSON.stringify(update.options) })
+ .where(eq(items.id, update.id));
+ }
+
+ await db.delete(integrationItems).where(inArray(integrationItems.integrationId, oldIntegrationIds));
+ await db.delete(integrations).where(inArray(integrations.id, oldIntegrationIds));
+
+ console.log(`Migrated widget-only integrations to widget options count="${updatedItems.length}"`);
+}
diff --git a/packages/db/migrations/custom/index.ts b/packages/db/migrations/custom/index.ts
index a6a002733..8bcc93c32 100644
--- a/packages/db/migrations/custom/index.ts
+++ b/packages/db/migrations/custom/index.ts
@@ -2,9 +2,11 @@ import type { Database } from "../..";
import { migrateReleaseWidgetProviderToOptionsAsync } from "./0000_release_widget_provider_to_options";
import { migrateOpnsenseCredentialsAsync } from "./0001_opnsense_credentials";
import { migrateAppWidgetShowDescriptionTooltipToDisplayModeAsync } from "./0002_app_widget_show_description_tooltip_to_display_mode";
+import { migrateWidgetOnlyIntegrationsToOptionsAsync } from "./0003_remove_widget_only_integrations";
export const applyCustomMigrationsAsync = async (db: Database) => {
await migrateReleaseWidgetProviderToOptionsAsync(db);
await migrateOpnsenseCredentialsAsync(db);
await migrateAppWidgetShowDescriptionTooltipToDisplayModeAsync(db);
+ await migrateWidgetOnlyIntegrationsToOptionsAsync(db);
};
diff --git a/packages/db/schema/index.ts b/packages/db/schema/index.ts
index 59566631f..8c3b7f4fc 100644
--- a/packages/db/schema/index.ts
+++ b/packages/db/schema/index.ts
@@ -51,6 +51,7 @@ export const {
cronJobConfigurations,
customWidgetDefinitions,
customWidgetSecrets,
+ widgetSecrets,
} = schema;
export type User = InferSelectModel;
diff --git a/packages/db/schema/mysql.ts b/packages/db/schema/mysql.ts
index 372a2aa9f..71af5dbd2 100644
--- a/packages/db/schema/mysql.ts
+++ b/packages/db/schema/mysql.ts
@@ -541,6 +541,25 @@ export const customWidgetSecrets = mysqlTable(
}),
);
+export const widgetSecrets = mysqlTable(
+ "widget_secret",
+ {
+ itemId: varchar({ length: 64 })
+ .notNull()
+ .references(() => items.id, { onDelete: "cascade" }),
+ kind: varchar({ length: 64 }).notNull(),
+ value: text().$type<`${string}.${string}`>().notNull(),
+ updatedAt: timestamp()
+ .$onUpdateFn(() => new Date())
+ .notNull(),
+ },
+ (table) => ({
+ compoundKey: primaryKey({
+ columns: [table.itemId, table.kind],
+ }),
+ }),
+);
+
export const cronJobConfigurations = mysqlTable("cron_job_configuration", {
name: varchar({ length: 256 }).notNull().primaryKey(),
cronExpression: varchar({ length: 32 }).notNull(),
@@ -746,12 +765,20 @@ export const sectionCollapseStateRelations = relations(sectionCollapseStates, ({
export const itemRelations = relations(items, ({ one, many }) => ({
integrations: many(integrationItems),
layouts: many(itemLayouts),
+ secrets: many(widgetSecrets),
board: one(boards, {
fields: [items.boardId],
references: [boards.id],
}),
}));
+export const widgetSecretRelations = relations(widgetSecrets, ({ one }) => ({
+ item: one(items, {
+ fields: [widgetSecrets.itemId],
+ references: [items.id],
+ }),
+}));
+
export const integrationItemRelations = relations(integrationItems, ({ one }) => ({
integration: one(integrations, {
fields: [integrationItems.integrationId],
diff --git a/packages/db/schema/postgresql.ts b/packages/db/schema/postgresql.ts
index 0e104f7f4..092ecc64b 100644
--- a/packages/db/schema/postgresql.ts
+++ b/packages/db/schema/postgresql.ts
@@ -540,6 +540,25 @@ export const customWidgetSecrets = pgTable(
}),
);
+export const widgetSecrets = pgTable(
+ "widget_secret",
+ {
+ itemId: varchar({ length: 64 })
+ .notNull()
+ .references(() => items.id, { onDelete: "cascade" }),
+ kind: varchar({ length: 64 }).notNull(),
+ value: text().$type<`${string}.${string}`>().notNull(),
+ updatedAt: timestamp()
+ .$onUpdateFn(() => new Date())
+ .notNull(),
+ },
+ (table) => ({
+ compoundKey: primaryKey({
+ columns: [table.itemId, table.kind],
+ }),
+ }),
+);
+
export const cronJobConfigurations = pgTable("cron_job_configuration", {
name: varchar({ length: 256 }).notNull().primaryKey(),
cronExpression: varchar({ length: 32 }).notNull(),
@@ -745,12 +764,20 @@ export const sectionCollapseStateRelations = relations(sectionCollapseStates, ({
export const itemRelations = relations(items, ({ one, many }) => ({
integrations: many(integrationItems),
layouts: many(itemLayouts),
+ secrets: many(widgetSecrets),
board: one(boards, {
fields: [items.boardId],
references: [boards.id],
}),
}));
+export const widgetSecretRelations = relations(widgetSecrets, ({ one }) => ({
+ item: one(items, {
+ fields: [widgetSecrets.itemId],
+ references: [items.id],
+ }),
+}));
+
export const integrationItemRelations = relations(integrationItems, ({ one }) => ({
integration: one(integrations, {
fields: [integrationItems.integrationId],
diff --git a/packages/db/schema/sqlite.ts b/packages/db/schema/sqlite.ts
index 309d58507..b791609d4 100644
--- a/packages/db/schema/sqlite.ts
+++ b/packages/db/schema/sqlite.ts
@@ -530,6 +530,25 @@ export const customWidgetSecrets = sqliteTable(
}),
);
+export const widgetSecrets = sqliteTable(
+ "widget_secret",
+ {
+ itemId: text()
+ .notNull()
+ .references(() => items.id, { onDelete: "cascade" }),
+ kind: text().notNull(),
+ value: text().$type<`${string}.${string}`>().notNull(),
+ updatedAt: int({ mode: "timestamp" })
+ .$onUpdateFn(() => new Date())
+ .notNull(),
+ },
+ (table) => ({
+ compoundKey: primaryKey({
+ columns: [table.itemId, table.kind],
+ }),
+ }),
+);
+
export const cronJobConfigurations = sqliteTable("cron_job_configuration", {
name: text().notNull().primaryKey(),
cronExpression: text().notNull(),
@@ -735,12 +754,20 @@ export const sectionCollapseStateRelations = relations(sectionCollapseStates, ({
export const itemRelations = relations(items, ({ one, many }) => ({
integrations: many(integrationItems),
layouts: many(itemLayouts),
+ secrets: many(widgetSecrets),
board: one(boards, {
fields: [items.boardId],
references: [boards.id],
}),
}));
+export const widgetSecretRelations = relations(widgetSecrets, ({ one }) => ({
+ item: one(items, {
+ fields: [widgetSecrets.itemId],
+ references: [items.id],
+ }),
+}));
+
export const integrationItemRelations = relations(integrationItems, ({ one }) => ({
integration: one(integrations, {
fields: [integrationItems.integrationId],
diff --git a/packages/definitions/src/docker-integration-match.ts b/packages/definitions/src/docker-integration-match.ts
index 9dcba12d4..e7e10809b 100644
--- a/packages/definitions/src/docker-integration-match.ts
+++ b/packages/definitions/src/docker-integration-match.ts
@@ -31,9 +31,6 @@ const integrationAliases: Partial> =
audiobookshelf: ["audiobookshelf"],
navidrome: ["navidrome"],
paperlessNgx: ["paperless-ngx", "paperless"],
- searchCh: ["search-ch"],
- gitHubContainerRegistry: ["ghcr"],
- linuxServerIO: ["linuxserver"],
coolify: ["coolify"],
truenas: ["truenas"],
};
@@ -63,19 +60,7 @@ export const matchIntegrationKind = (search: string): IntegrationKind | null =>
return null;
};
-const notDockerDiscoverable = new Set([
- "dockerHub",
- "github",
- "gitlab",
- "npm",
- "codeberg",
- "linuxServerIO",
- "gitHubContainerRegistry",
- "quay",
- "ical",
- "searchCh",
- "mock",
-]);
+const notDockerDiscoverable = new Set(["ical", "mock"]);
interface ContainerMatchInput {
image: string;
diff --git a/packages/definitions/src/docs/homarr-docs-sitemap.ts b/packages/definitions/src/docs/homarr-docs-sitemap.ts
index efc75332c..6c1dd40fc 100644
--- a/packages/definitions/src/docs/homarr-docs-sitemap.ts
+++ b/packages/definitions/src/docs/homarr-docs-sitemap.ts
@@ -316,14 +316,6 @@ export type HomarrDocumentationPath =
| "/docs/integrations/nextcloud"
| "/docs/integrations/unifi-controller"
| "/docs/integrations/opnsense"
- | "/docs/integrations/github"
- | "/docs/integrations/docker-hub"
- | "/docs/integrations/gitlab"
- | "/docs/integrations/npm"
- | "/docs/integrations/codeberg"
- | "/docs/integrations/linux-server-io"
- | "/docs/integrations/github-containerregistry"
- | "/docs/integrations/quay"
| "/docs/integrations/ntfy"
| "/docs/integrations/gotify"
| "/docs/integrations/ical"
@@ -331,7 +323,6 @@ export type HomarrDocumentationPath =
| "/docs/integrations/truenas"
| "/docs/integrations/unraid"
| "/docs/integrations/coolify"
- | "/docs/integrations/search-ch"
| "/docs/integrations/immich"
| "/docs/integrations/paperless-ngx"
| "/docs/integrations/tracearr"
diff --git a/packages/definitions/src/docs/integration-doc-slugs.ts b/packages/definitions/src/docs/integration-doc-slugs.ts
index 90c3cae8b..ca19d4de6 100644
--- a/packages/definitions/src/docs/integration-doc-slugs.ts
+++ b/packages/definitions/src/docs/integration-doc-slugs.ts
@@ -31,14 +31,6 @@ export const integrationDocSlugs: Record = {
nextcloud: "nextcloud",
unifiController: "unifi-controller",
opnsense: "opnsense",
- github: "github",
- dockerHub: "docker-hub",
- gitlab: "gitlab",
- npm: "npm",
- codeberg: "codeberg",
- linuxServerIO: "linux-server-io",
- gitHubContainerRegistry: "github-containerregistry",
- quay: "quay",
ntfy: "ntfy",
gotify: "gotify",
ical: "ical",
@@ -46,7 +38,6 @@ export const integrationDocSlugs: Record = {
truenas: "truenas",
unraid: "unraid",
coolify: "coolify",
- searchCh: "search-ch",
immich: "immich",
paperlessNgx: "paperless-ngx",
tracearr: "tracearr",
diff --git a/packages/definitions/src/index.ts b/packages/definitions/src/index.ts
index eb81e4d18..94b392ee7 100644
--- a/packages/definitions/src/index.ts
+++ b/packages/definitions/src/index.ts
@@ -17,3 +17,4 @@ export * from "./emptysuperjson";
export * from "./hotkeys";
export * from "./docker-integration-match";
export * from "./integration-url-template";
+export * from "./release-provider";
diff --git a/packages/definitions/src/integration.ts b/packages/definitions/src/integration.ts
index d6c3a2f58..15c94f80d 100644
--- a/packages/definitions/src/integration.ts
+++ b/packages/definitions/src/integration.ts
@@ -283,70 +283,6 @@ export const integrationDefs = {
documentationUrl: createDocumentationLink("/docs/integrations/opnsense"),
defaultPort: 443,
},
- github: {
- name: "Github",
- secretKinds: [[], ["personalAccessToken"], ["githubAppId", "githubInstallationId", "privateKey"]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/github.svg",
- category: ["releasesProvider"],
- defaultUrl: "https://api.github.com",
- documentationUrl: createDocumentationLink("/docs/integrations/github"),
- },
- dockerHub: {
- name: "Docker Hub",
- secretKinds: [[], ["username", "personalAccessToken"]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/docker.svg",
- category: ["releasesProvider"],
- defaultUrl: "https://hub.docker.com",
- documentationUrl: createDocumentationLink("/docs/integrations/docker-hub"),
- },
- gitlab: {
- name: "Gitlab",
- secretKinds: [[], ["personalAccessToken"]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/gitlab.svg",
- category: ["releasesProvider"],
- defaultUrl: "https://gitlab.com",
- documentationUrl: createDocumentationLink("/docs/integrations/gitlab"),
- },
- npm: {
- name: "NPM",
- secretKinds: [[]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/npm.svg",
- category: ["releasesProvider"],
- defaultUrl: "https://registry.npmjs.org",
- documentationUrl: createDocumentationLink("/docs/integrations/npm"),
- },
- codeberg: {
- name: "Codeberg",
- secretKinds: [[], ["personalAccessToken"]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/codeberg.svg",
- category: ["releasesProvider"],
- defaultUrl: "https://codeberg.org",
- documentationUrl: createDocumentationLink("/docs/integrations/codeberg"),
- },
- linuxServerIO: {
- name: "LinuxServer.io",
- secretKinds: [[]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/linuxserver-io.svg",
- category: ["releasesProvider"],
- defaultUrl: "https://api.linuxserver.io",
- documentationUrl: createDocumentationLink("/docs/integrations/linux-server-io"),
- },
- gitHubContainerRegistry: {
- name: "GitHub Container Registry",
- secretKinds: [[], ["personalAccessToken"], ["githubAppId", "githubInstallationId", "privateKey"]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/github.svg",
- category: ["releasesProvider"],
- defaultUrl: "https://api.github.com",
- documentationUrl: createDocumentationLink("/docs/integrations/github"),
- },
- quay: {
- name: "Quay",
- secretKinds: [[], ["personalAccessToken"]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/quay.png",
- category: ["releasesProvider"],
- defaultUrl: "https://quay.io",
- documentationUrl: createDocumentationLink("/docs/integrations/quay"),
- },
ntfy: {
name: "ntfy",
secretKinds: [["topic"], ["topic", "apiKey"]],
@@ -401,13 +337,6 @@ export const integrationDefs = {
documentationUrl: createDocumentationLink("/docs/integrations/coolify"),
defaultPort: 8000,
},
- searchCh: {
- name: "Search.ch",
- secretKinds: [[]],
- iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/search-ch.png",
- category: ["timetable"],
- documentationUrl: createDocumentationLink("/docs/integrations/search-ch"),
- },
immich: {
name: "Immich",
secretKinds: [["apiKey"]],
@@ -501,8 +430,8 @@ export const integrationDefs = {
secretKinds: [[], ["username", "password"]],
iconUrl: "https://cdn.jsdelivr.net/gh/selfhst/icons/png/archiveteam-warrior.png",
category: ["archiving"],
+ documentationUrl: null,
defaultUrl: "http://localhost:8001",
- documentationUrl: createDocumentationLink("/docs/integrations/archiveteam-warrior"),
},
// This integration only returns mock data, it is used during development (but can also be used in production by directly going to the create page)
mock: {
@@ -602,7 +531,6 @@ export const integrationCategories = [
"search",
"mediaTranscoding",
"networkController",
- "releasesProvider",
"notifications",
"firewall",
"timetable",
diff --git a/packages/definitions/src/release-provider.ts b/packages/definitions/src/release-provider.ts
new file mode 100644
index 000000000..3fa53cc8f
--- /dev/null
+++ b/packages/definitions/src/release-provider.ts
@@ -0,0 +1,78 @@
+import { objectKeys } from "@homarr/common";
+
+export const releaseProviderDefs = {
+ github: {
+ name: "Github",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/github.svg",
+ defaultUrl: "https://api.github.com",
+ },
+ dockerHub: {
+ name: "Docker Hub",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/docker.svg",
+ defaultUrl: "https://hub.docker.com",
+ },
+ gitlab: {
+ name: "Gitlab",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/gitlab.svg",
+ defaultUrl: "https://gitlab.com",
+ },
+ npm: {
+ name: "NPM",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/npm.svg",
+ defaultUrl: "https://registry.npmjs.org",
+ },
+ codeberg: {
+ name: "Codeberg",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/codeberg.svg",
+ defaultUrl: "https://codeberg.org",
+ },
+ linuxServerIO: {
+ name: "LinuxServer.io",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/linuxserver-io.svg",
+ defaultUrl: "https://api.linuxserver.io",
+ },
+ gitHubContainerRegistry: {
+ name: "GitHub Container Registry",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/github.svg",
+ defaultUrl: "https://ghcr.io",
+ },
+ quay: {
+ name: "Quay",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/quay.png",
+ defaultUrl: "https://quay.io",
+ },
+} as const;
+
+export const releaseProviderKinds = objectKeys(releaseProviderDefs);
+export type ReleaseProviderKind = keyof typeof releaseProviderDefs;
+
+export const getReleaseProviderName = (provider: ReleaseProviderKind) => releaseProviderDefs[provider].name;
+export const getReleaseProviderIconUrl = (provider: ReleaseProviderKind) => releaseProviderDefs[provider].iconUrl;
+export const getReleaseProviderDefaultUrl = (provider: ReleaseProviderKind) => releaseProviderDefs[provider].defaultUrl;
+
+const releaseProviderRegistryPrefixes: Partial> = {
+ dockerHub: "docker.io/",
+ gitHubContainerRegistry: "ghcr.io/",
+ linuxServerIO: "lscr.io/",
+ quay: "quay.io/",
+};
+
+const removeContainerImageVersion = (identifier: string) => {
+ const digestIndex = identifier.indexOf("@");
+ const withoutDigest = digestIndex === -1 ? identifier : identifier.slice(0, digestIndex);
+ const tagIndex = withoutDigest.indexOf(":", withoutDigest.lastIndexOf("/") + 1);
+
+ return tagIndex === -1 ? withoutDigest : withoutDigest.slice(0, tagIndex);
+};
+
+export const normalizeReleaseProviderIdentifier = (provider: ReleaseProviderKind, identifier: string) => {
+ const trimmedIdentifier = identifier.trim();
+ const registryPrefix = releaseProviderRegistryPrefixes[provider];
+ const withoutRegistry =
+ registryPrefix && trimmedIdentifier.startsWith(registryPrefix)
+ ? trimmedIdentifier.slice(registryPrefix.length)
+ : trimmedIdentifier;
+
+ // ponytail: only strip container image versions/digests for providers that use them
+ return registryPrefix ? removeContainerImageVersion(withoutRegistry) : withoutRegistry;
+};
diff --git a/packages/definitions/src/test/release-provider.spec.ts b/packages/definitions/src/test/release-provider.spec.ts
new file mode 100644
index 000000000..7e7e0b90e
--- /dev/null
+++ b/packages/definitions/src/test/release-provider.spec.ts
@@ -0,0 +1,32 @@
+import { describe, expect, it } from "vitest";
+
+import { normalizeReleaseProviderIdentifier } from "../release-provider";
+
+describe("normalizeReleaseProviderIdentifier", () => {
+ it("normalizes full ghcr image references", () => {
+ expect(normalizeReleaseProviderIdentifier("gitHubContainerRegistry", "ghcr.io/muchobien/pocketbase:latest")).toBe(
+ "muchobien/pocketbase",
+ );
+ expect(normalizeReleaseProviderIdentifier("gitHubContainerRegistry", "ghcr.io/homarr-labs/homarr:latest")).toBe(
+ "homarr-labs/homarr",
+ );
+ });
+
+ it("keeps existing ghcr owner/name identifiers unchanged", () => {
+ expect(normalizeReleaseProviderIdentifier("gitHubContainerRegistry", "homarr-labs/homarr")).toBe(
+ "homarr-labs/homarr",
+ );
+ });
+
+ it("normalizes container image identifiers for other registries", () => {
+ expect(normalizeReleaseProviderIdentifier("dockerHub", "postgres:17")).toBe("postgres");
+ expect(normalizeReleaseProviderIdentifier("dockerHub", "docker.io/library/postgres:17")).toBe("library/postgres");
+ expect(normalizeReleaseProviderIdentifier("dockerHub", "library/postgres@sha256:abc123")).toBe("library/postgres");
+ expect(normalizeReleaseProviderIdentifier("linuxServerIO", "lscr.io/linuxserver/radarr:latest")).toBe(
+ "linuxserver/radarr",
+ );
+ expect(normalizeReleaseProviderIdentifier("quay", "quay.io/prometheus/prometheus:v3.0.0")).toBe(
+ "prometheus/prometheus",
+ );
+ });
+});
diff --git a/packages/definitions/src/widget-integration-map.ts b/packages/definitions/src/widget-integration-map.ts
index a560f2979..deb953781 100644
--- a/packages/definitions/src/widget-integration-map.ts
+++ b/packages/definitions/src/widget-integration-map.ts
@@ -30,7 +30,6 @@ export const widgetIntegrationSupport: Partial([
- "searchCh",
- "github",
- "dockerHub",
- "gitlab",
- "npm",
- "codeberg",
- "linuxServerIO",
- "gitHubContainerRegistry",
- "quay",
- "mock",
-]);
+export const hiddenFromOnboarding = new Set(["mock"]);
export const defaultBookmarkApps = [
{
diff --git a/packages/integrations/package.json b/packages/integrations/package.json
index 6e0c81039..d36be1852 100644
--- a/packages/integrations/package.json
+++ b/packages/integrations/package.json
@@ -27,7 +27,6 @@
"@ctrl/deluge": "catalog:",
"@ctrl/qbittorrent": "catalog:",
"@ctrl/transmission": "catalog:",
- "@gitbeaker/rest": "catalog:",
"@homarr/common": "workspace:^0.1.0",
"@homarr/core": "workspace:^0.1.0",
"@homarr/db": "workspace:^0.1.0",
@@ -39,7 +38,6 @@
"@homarr/validation": "workspace:^0.1.0",
"@immich/sdk": "catalog:",
"@jellyfin/sdk": "catalog:",
- "@octokit/auth-app": "catalog:",
"ical.js": "catalog:",
"maria2": "catalog:",
"octokit": "catalog:",
diff --git a/packages/integrations/src/base/creator.ts b/packages/integrations/src/base/creator.ts
index 13ed36537..1a84134fc 100644
--- a/packages/integrations/src/base/creator.ts
+++ b/packages/integrations/src/base/creator.ts
@@ -3,12 +3,9 @@ import type { IntegrationKind } from "@homarr/definitions";
import { AdGuardHomeIntegration } from "../adguard-home/adguard-home-integration";
import { BeszelIntegration } from "../beszel/beszel-integration";
import { AnchorIntegration } from "../anchor/anchor-integration";
-import { ArchiveTeamWarriorIntegration } from "../archive-team-warrior/archive-team-warrior-integration";
import { AudiobookshelfIntegration } from "../audiobookshelf/audiobookshelf-integration";
-import { CodebergIntegration } from "../codeberg/codeberg-integration";
import { CoolifyIntegration } from "../coolify/coolify-integration";
import { DashDotIntegration } from "../dashdot/dashdot-integration";
-import { DockerHubIntegration } from "../docker-hub/docker-hub-integration";
import { Aria2Integration } from "../download-client/aria2/aria2-integration";
import { DelugeIntegration } from "../download-client/deluge/deluge-integration";
import { NzbGetIntegration } from "../download-client/nzbget/nzbget-integration";
@@ -17,17 +14,14 @@ import { SabnzbdIntegration } from "../download-client/sabnzbd/sabnzbd-integrati
import { SlskdIntegration } from "../download-client/slskd/slskd-integration";
import { TransmissionIntegration } from "../download-client/transmission/transmission-integration";
import { EmbyIntegration } from "../emby/emby-integration";
-import { GitHubContainerRegistryIntegration } from "../github-container-registry/github-container-registry-integration";
-import { GithubIntegration } from "../github/github-integration";
-import { GitlabIntegration } from "../gitlab/gitlab-integration";
import { GlancesIntegration } from "../glances/glances-integration";
+import { ArchiveTeamWarriorIntegration } from "../archive-team-warrior/archive-team-warrior-integration";
import { GluetunIntegration } from "../gluetun/gluetun-integration";
import { HomeAssistantIntegration } from "../homeassistant/homeassistant-integration";
import { ICalIntegration } from "../ical/ical-integration";
import { ImmichIntegration } from "../immich/immich-integration";
import { JellyfinIntegration } from "../jellyfin/jellyfin-integration";
import { JellyseerrIntegration } from "../jellyseerr/jellyseerr-integration";
-import { LinuxServerIOIntegration } from "../linuxserverio/linuxserverio-integration";
import { LidarrIntegration } from "../media-organizer/lidarr/lidarr-integration";
import { RadarrIntegration } from "../media-organizer/radarr/radarr-integration";
import { ReadarrIntegration } from "../media-organizer/readarr/readarr-integration";
@@ -36,7 +30,6 @@ import { TdarrIntegration } from "../media-transcoding/tdarr-integration";
import { MockIntegration } from "../mock/mock-integration";
import { NavidromeIntegration } from "../navidrome/navidrome-integration";
import { NextcloudIntegration } from "../nextcloud/nextcloud.integration";
-import { NPMIntegration } from "../npm/npm-integration";
import { GotifyIntegration } from "../gotify/gotify-integration";
import { NTFYIntegration } from "../ntfy/ntfy-integration";
import { OpenMediaVaultIntegration } from "../openmediavault/openmediavault-integration";
@@ -49,8 +42,6 @@ import { createTechnitiumDnsIntegrationAsync } from "../technitium/technitium-in
import { PlexIntegration } from "../plex/plex-integration";
import { ProwlarrIntegration } from "../prowlarr/prowlarr-integration";
import { ProxmoxIntegration } from "../proxmox/proxmox-integration";
-import { QuayIntegration } from "../quay/quay-integration";
-import { SearchChIntegration } from "../search-ch/search-ch-integration";
import { SeerrIntegration } from "../seerr/seerr-integration";
import { SpeedtestTrackerIntegration } from "../speedtest-tracker/speedtest-tracker-integration";
import { TracearrIntegration } from "../tracearr/tracearr-integration";
@@ -114,15 +105,7 @@ export const integrationCreators = {
nextcloud: NextcloudIntegration,
unifiController: UnifiControllerIntegration,
opnsense: OPNsenseIntegration,
- github: GithubIntegration,
- dockerHub: DockerHubIntegration,
- gitlab: GitlabIntegration,
- npm: NPMIntegration,
- codeberg: CodebergIntegration,
- linuxServerIO: LinuxServerIOIntegration,
- gitHubContainerRegistry: GitHubContainerRegistryIntegration,
ical: ICalIntegration,
- quay: QuayIntegration,
ntfy: NTFYIntegration,
gotify: GotifyIntegration,
mock: MockIntegration,
@@ -131,7 +114,6 @@ export const integrationCreators = {
coolify: CoolifyIntegration,
tracearr: TracearrIntegration,
glances: GlancesIntegration,
- searchCh: SearchChIntegration,
immich: ImmichIntegration,
paperlessNgx: PaperlessNgxIntegration,
speedtestTracker: SpeedtestTrackerIntegration,
diff --git a/packages/integrations/src/codeberg/codeberg-integration.ts b/packages/integrations/src/codeberg/codeberg-integration.ts
deleted file mode 100644
index 2396a81e0..000000000
--- a/packages/integrations/src/codeberg/codeberg-integration.ts
+++ /dev/null
@@ -1,144 +0,0 @@
-import type { RequestInit, Response } from "undici";
-
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-import { createLogger } from "@homarr/core/infrastructure/logs";
-
-import type { IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import { TestConnectionError } from "../base/test-connection/test-connection-error";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { ReleasesProviderIntegration } from "../interfaces/releases-providers/releases-providers-integration";
-import { getLatestRelease } from "../interfaces/releases-providers/releases-providers-integration";
-import type {
- DetailsProviderResponse,
- ReleaseResponse,
-} from "../interfaces/releases-providers/releases-providers-types";
-import { detailsResponseSchema, releasesResponseSchema } from "./codeberg-schemas";
-
-const logger = createLogger({ module: "codebergIntegration" });
-
-export class CodebergIntegration extends Integration implements ReleasesProviderIntegration {
- private async withHeadersAsync(callback: (headers: RequestInit["headers"]) => Promise): Promise {
- if (!this.hasSecretValue("personalAccessToken")) return await callback(undefined);
-
- return await callback({
- Authorization: `token ${this.getSecretValue("personalAccessToken")}`,
- });
- }
-
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const response = await this.withHeadersAsync(async (headers) => {
- return await input.fetchAsync(this.url("/version"), {
- headers,
- });
- });
-
- if (!response.ok) {
- return TestConnectionError.StatusResult(response);
- }
-
- return {
- success: true,
- };
- }
-
- private parseIdentifier(identifier: string) {
- const [owner, name] = identifier.split("/");
- if (!owner || !name) {
- logger.warn("Invalid identifier format. Expected 'owner/name', for identifier", {
- identifier,
- });
- return null;
- }
- return { owner, name };
- }
-
- public async getLatestMatchingReleaseAsync(identifier: string, versionRegex?: string): Promise {
- const parsedIdentifier = this.parseIdentifier(identifier);
- if (!parsedIdentifier) return { success: false, error: { code: "invalidIdentifier" } };
-
- const { owner, name } = parsedIdentifier;
-
- const releasesResponse = await this.withHeadersAsync(async (headers) => {
- return await fetchWithTrustedCertificatesAsync(
- this.url(`/api/v1/repos/${encodeURIComponent(owner)}/${encodeURIComponent(name)}/releases`),
- { headers },
- );
- });
- if (!releasesResponse.ok) {
- return { success: false, error: { code: "unexpected", message: releasesResponse.statusText } };
- }
-
- const releasesResponseJson: unknown = await releasesResponse.json();
- const { data, success, error } = releasesResponseSchema.safeParse(releasesResponseJson);
- if (!success) {
- return {
- success: false,
- error: {
- code: "unexpected",
- message: releasesResponseJson ? JSON.stringify(releasesResponseJson, null, 2) : error.message,
- },
- };
- }
-
- const formattedReleases = data.map((tag) => ({
- latestRelease: tag.tag_name,
- latestReleaseAt: tag.published_at,
- releaseUrl: tag.url,
- releaseDescription: tag.body,
- isPreRelease: tag.prerelease,
- }));
-
- const latestRelease = getLatestRelease(formattedReleases, versionRegex);
- if (!latestRelease) return { success: false, error: { code: "noMatchingVersion" } };
-
- const details = await this.getDetailsAsync(owner, name);
-
- return { success: true, data: { ...details, ...latestRelease } };
- }
-
- protected async getDetailsAsync(owner: string, name: string): Promise {
- const response = await this.withHeadersAsync(async (headers) => {
- return await fetchWithTrustedCertificatesAsync(
- this.url(`/api/v1/repos/${encodeURIComponent(owner)}/${encodeURIComponent(name)}`),
- {
- headers,
- },
- );
- });
-
- if (!response.ok) {
- logger.warn("Failed to get details", {
- owner,
- name,
- error: response.statusText,
- });
-
- return undefined;
- }
-
- const responseJson = await response.json();
- const { data, success, error } = detailsResponseSchema.safeParse(responseJson);
-
- if (!success) {
- logger.warn("Failed to parse details", {
- owner,
- name,
- error,
- });
-
- return undefined;
- }
-
- return {
- projectUrl: data.html_url,
- projectDescription: data.description,
- isFork: data.fork,
- isArchived: data.archived,
- createdAt: data.created_at,
- starsCount: data.stars_count,
- openIssues: data.open_issues_count,
- forksCount: data.forks_count,
- };
- }
-}
diff --git a/packages/integrations/src/codeberg/codeberg-schemas.ts b/packages/integrations/src/codeberg/codeberg-schemas.ts
deleted file mode 100644
index ff6e62a01..000000000
--- a/packages/integrations/src/codeberg/codeberg-schemas.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-import { z } from "zod/v4";
-
-export const releasesResponseSchema = z.array(
- z.object({
- tag_name: z.string(),
- published_at: z.string().transform((value) => new Date(value)),
- url: z.string(),
- body: z.string(),
- prerelease: z.boolean(),
- }),
-);
-
-export const detailsResponseSchema = z.object({
- html_url: z.string(),
- description: z.string(),
- fork: z.boolean(),
- archived: z.boolean(),
- created_at: z.string().transform((value) => new Date(value)),
- stars_count: z.number(),
- open_issues_count: z.number(),
- forks_count: z.number(),
-});
diff --git a/packages/integrations/src/docker-hub/docker-hub-integration.ts b/packages/integrations/src/docker-hub/docker-hub-integration.ts
deleted file mode 100644
index b9e9ea09c..000000000
--- a/packages/integrations/src/docker-hub/docker-hub-integration.ts
+++ /dev/null
@@ -1,190 +0,0 @@
-import type { fetch, RequestInit, Response } from "undici";
-
-import { ResponseError } from "@homarr/common/server";
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-import { createLogger } from "@homarr/core/infrastructure/logs";
-
-import type { IntegrationInput, IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import type { SessionStore } from "../base/session-store";
-import { createSessionStore } from "../base/session-store";
-import { TestConnectionError } from "../base/test-connection/test-connection-error";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { ReleasesProviderIntegration } from "../interfaces/releases-providers/releases-providers-integration";
-import { getLatestRelease } from "../interfaces/releases-providers/releases-providers-integration";
-import type {
- DetailsProviderResponse,
- ReleaseResponse,
-} from "../interfaces/releases-providers/releases-providers-types";
-import { accessTokenResponseSchema, detailsResponseSchema, releasesResponseSchema } from "./docker-hub-schemas";
-
-const logger = createLogger({ module: "dockerHubIntegration" });
-
-export class DockerHubIntegration extends Integration implements ReleasesProviderIntegration {
- private readonly sessionStore: SessionStore;
-
- constructor(integration: IntegrationInput) {
- super(integration);
- this.sessionStore = createSessionStore(integration);
- }
-
- private async withHeadersAsync(callback: (headers: RequestInit["headers"]) => Promise): Promise {
- if (!this.hasSecretValue("username") || !this.hasSecretValue("personalAccessToken"))
- return await callback(undefined);
-
- const storedSession = await this.sessionStore.getAsync();
-
- if (storedSession) {
- logger.debug("Using stored session for request", { integrationId: this.integration.id });
- const response = await callback({
- Authorization: `Bearer ${storedSession}`,
- });
- if (response.status !== 401) {
- return response;
- }
-
- logger.debug("Session expired, getting new session", { integrationId: this.integration.id });
- }
-
- const accessToken = await this.getSessionAsync();
- await this.sessionStore.setAsync(accessToken);
- return await callback({
- Authorization: `Bearer ${accessToken}`,
- });
- }
-
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const hasAuth = this.hasSecretValue("username") && this.hasSecretValue("personalAccessToken");
-
- if (hasAuth) {
- logger.debug("Testing DockerHub connection with authentication", { integrationId: this.integration.id });
- await this.getSessionAsync(input.fetchAsync);
- } else {
- logger.debug("Testing DockerHub connection without authentication", { integrationId: this.integration.id });
- const response = await input.fetchAsync(this.url("/v2/repositories/library"));
- if (!response.ok) {
- return TestConnectionError.StatusResult(response);
- }
- }
-
- return {
- success: true,
- };
- }
-
- private parseIdentifier(identifier: string) {
- if (!identifier.includes("/")) return { owner: "", name: identifier };
- const [owner, name] = identifier.split("/");
- if (!owner || !name) {
- logger.warn("Invalid identifier format. Expected 'owner/name' or 'name', for identifier", {
- identifier,
- });
- return null;
- }
- return { owner, name };
- }
-
- public async getLatestMatchingReleaseAsync(identifier: string, versionRegex?: string): Promise {
- const parsedIdentifier = this.parseIdentifier(identifier);
- if (!parsedIdentifier) return { success: false, error: { code: "invalidIdentifier" } };
-
- const { owner, name } = parsedIdentifier;
-
- const relativeUrl: `/${string}` = owner
- ? `/v2/namespaces/${encodeURIComponent(owner)}/repositories/${encodeURIComponent(name)}`
- : `/v2/repositories/library/${encodeURIComponent(name)}`;
-
- for (let page = 0; page <= 5; page++) {
- const releasesResponse = await this.withHeadersAsync(async (headers) => {
- return await fetchWithTrustedCertificatesAsync(this.url(`${relativeUrl}/tags?page_size=100&page=${page}`), {
- headers,
- });
- });
- if (!releasesResponse.ok) {
- return { success: false, error: { code: "unexpected", message: releasesResponse.statusText } };
- }
-
- const releasesResponseJson: unknown = await releasesResponse.json();
- const releasesResult = releasesResponseSchema.safeParse(releasesResponseJson);
- if (!releasesResult.success) {
- return {
- success: false,
- error: {
- code: "unexpected",
- message: releasesResponseJson
- ? JSON.stringify(releasesResponseJson, null, 2)
- : releasesResult.error.message,
- },
- };
- }
-
- const latestRelease = getLatestRelease(releasesResult.data.results, versionRegex);
- if (!latestRelease) continue;
-
- const details = await this.getDetailsAsync(relativeUrl);
-
- return { success: true, data: { ...details, ...latestRelease } };
- }
-
- return { success: false, error: { code: "noMatchingVersion" } };
- }
-
- private async getDetailsAsync(relativeUrl: `/${string}`): Promise {
- const response = await this.withHeadersAsync(async (headers) => {
- return await fetchWithTrustedCertificatesAsync(this.url(`${relativeUrl}/`), {
- headers,
- });
- });
-
- if (!response.ok) {
- logger.warn("Failed to get details response", {
- relativeUrl,
- error: response.statusText,
- });
-
- return undefined;
- }
-
- const responseJson = await response.json();
- const { data, success, error } = detailsResponseSchema.safeParse(responseJson);
-
- if (!success) {
- logger.warn("Failed to parse details response", {
- relativeUrl,
- error,
- });
-
- return undefined;
- }
-
- return {
- projectUrl: `https://hub.docker.com/r/${data.namespace === "library" ? "_" : data.namespace}/${data.name}`,
- projectDescription: data.description,
- createdAt: data.date_registered,
- starsCount: data.star_count,
- };
- }
-
- private async getSessionAsync(fetchAsync: typeof fetch = fetchWithTrustedCertificatesAsync): Promise {
- const response = await fetchAsync(this.url("/v2/auth/token"), {
- method: "POST",
- body: JSON.stringify({
- identifier: this.getSecretValue("username"),
- secret: this.getSecretValue("personalAccessToken"),
- }),
- });
-
- if (!response.ok) throw new ResponseError(response);
-
- const data = await response.json();
- const result = await accessTokenResponseSchema.parseAsync(data);
-
- if (!result.access_token) {
- throw new ResponseError({ status: 401, url: response.url });
- }
-
- logger.info("Received session successfully", { integrationId: this.integration.id });
-
- return result.access_token;
- }
-}
diff --git a/packages/integrations/src/docker-hub/docker-hub-schemas.ts b/packages/integrations/src/docker-hub/docker-hub-schemas.ts
deleted file mode 100644
index 674ae5532..000000000
--- a/packages/integrations/src/docker-hub/docker-hub-schemas.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-import { z } from "zod/v4";
-
-export const accessTokenResponseSchema = z.object({
- access_token: z.string(),
-});
-
-export const releasesResponseSchema = z.object({
- results: z.array(
- z.object({ name: z.string(), last_updated: z.string().transform((value) => new Date(value)) }).transform((tag) => ({
- latestRelease: tag.name,
- latestReleaseAt: tag.last_updated,
- })),
- ),
-});
-
-export const detailsResponseSchema = z.object({
- name: z.string(),
- namespace: z.string(),
- description: z.string(),
- star_count: z.number(),
- date_registered: z.string().transform((value) => new Date(value)),
-});
diff --git a/packages/integrations/src/github-container-registry/github-container-registry-integration.ts b/packages/integrations/src/github-container-registry/github-container-registry-integration.ts
deleted file mode 100644
index 1400551a8..000000000
--- a/packages/integrations/src/github-container-registry/github-container-registry-integration.ts
+++ /dev/null
@@ -1,166 +0,0 @@
-import { createAppAuth } from "@octokit/auth-app";
-import { Octokit, RequestError } from "octokit";
-import type { fetch } from "undici";
-
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-import { createLogger } from "@homarr/core/infrastructure/logs";
-
-import { HandleIntegrationErrors } from "../base/errors/decorator";
-import { integrationOctokitHttpErrorHandler } from "../base/errors/http";
-import type { IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { ReleasesProviderIntegration } from "../interfaces/releases-providers/releases-providers-integration";
-import { getLatestRelease } from "../interfaces/releases-providers/releases-providers-integration";
-import type {
- DetailsProviderResponse,
- ReleaseProviderResponse,
- ReleaseResponse,
-} from "../interfaces/releases-providers/releases-providers-types";
-
-const logger = createLogger({ module: "githubContainerRegistryIntegration" });
-
-@HandleIntegrationErrors([integrationOctokitHttpErrorHandler])
-export class GitHubContainerRegistryIntegration extends Integration implements ReleasesProviderIntegration {
- private static readonly userAgent = "Homarr-Lab/Homarr:GitHubContainerRegistryIntegration";
-
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const api = this.getApi(input.fetchAsync);
-
- if (this.hasSecretValue("personalAccessToken")) {
- await api.rest.users.getAuthenticated();
- } else if (this.hasSecretValue("githubAppId")) {
- await api.rest.apps.getInstallation({
- installation_id: Number(this.getSecretValue("githubInstallationId")),
- });
- } else {
- await api.request("GET /octocat");
- }
-
- return {
- success: true,
- };
- }
-
- private parseIdentifier(identifier: string) {
- const [owner, name] = identifier.split("/");
- if (!owner || !name) {
- logger.warn("Invalid identifier format. Expected 'owner/name', for identifier", { identifier });
- return null;
- }
- return { owner, name };
- }
-
- public async getLatestMatchingReleaseAsync(identifier: string, versionRegex?: string): Promise {
- const parsedIdentifier = this.parseIdentifier(identifier);
- if (!parsedIdentifier) return { success: false, error: { code: "invalidIdentifier" } };
-
- const { owner, name } = parsedIdentifier;
- const api = this.getApi();
-
- try {
- const releasesResponse = await api.rest.packages.getAllPackageVersionsForPackageOwnedByUser({
- username: owner,
- package_type: "container",
- package_name: name,
- per_page: 100,
- });
-
- const releasesProviderResponse = releasesResponse.data.reduce((acc, release) => {
- if (!release.metadata?.container?.tags || !(release.metadata.container.tags.length > 0)) return acc;
-
- release.metadata.container.tags.forEach((tag) => {
- acc.push({
- latestRelease: tag,
- latestReleaseAt: new Date(release.updated_at),
- releaseUrl: release.html_url,
- releaseDescription: release.description ?? undefined,
- });
- });
- return acc;
- }, []);
-
- const latestRelease = getLatestRelease(releasesProviderResponse, versionRegex);
- if (!latestRelease) return { success: false, error: { code: "noMatchingVersion" } };
-
- const details = await this.getDetailsAsync(api, owner, name);
-
- return { success: true, data: { ...details, ...latestRelease } };
- } catch (error) {
- const errorMessage = error instanceof RequestError ? error.message : String(error);
- logger.warn("Failed to get releases", {
- owner,
- name,
- error: errorMessage,
- });
- return { success: false, error: { code: "unexpected", message: errorMessage } };
- }
- }
-
- protected async getDetailsAsync(
- api: Octokit,
- owner: string,
- name: string,
- ): Promise {
- try {
- const response = await api.rest.packages.getPackageForUser({
- username: owner,
- package_type: "container",
- package_name: name,
- });
-
- return {
- projectUrl: response.data.repository?.html_url ?? response.data.html_url,
- projectDescription: response.data.repository?.description ?? undefined,
- isFork: response.data.repository?.fork,
- isArchived: response.data.repository?.archived,
- createdAt: new Date(response.data.created_at),
- starsCount: response.data.repository?.stargazers_count,
- openIssues: response.data.repository?.open_issues_count,
- forksCount: response.data.repository?.forks_count,
- };
- } catch (error) {
- logger.warn("Failed to get details", {
- owner,
- name,
- error: error instanceof RequestError ? error.message : String(error),
- });
- return undefined;
- }
- }
-
- private getAuthProperties(): Pick {
- if (this.hasSecretValue("personalAccessToken"))
- return {
- auth: this.getSecretValue("personalAccessToken"),
- };
-
- if (this.hasSecretValue("githubAppId"))
- return {
- authStrategy: createAppAuth,
- auth: {
- appId: this.getSecretValue("githubAppId"),
- installationId: this.getSecretValue("githubInstallationId"),
- privateKey: this.getSecretValue("privateKey"),
- } satisfies Parameters[0],
- };
-
- return {};
- }
-
- private getApi(customFetch?: typeof fetch) {
- return new Octokit({
- baseUrl: this.url("/").origin,
- request: {
- fetch: customFetch ?? fetchWithTrustedCertificatesAsync,
- },
- userAgent: GitHubContainerRegistryIntegration.userAgent,
- // Disable throttling for this integration, Octokit will retry by default after a set time,
- // thus delaying the repsonse to the user in case of errors. Errors will be shown to the user, no need to retry the request.
- throttle: { enabled: false },
- ...this.getAuthProperties(),
- });
- }
-}
-
-type OctokitOptions = Exclude[0], undefined>;
diff --git a/packages/integrations/src/github/github-integration.ts b/packages/integrations/src/github/github-integration.ts
deleted file mode 100644
index 01548ecc6..000000000
--- a/packages/integrations/src/github/github-integration.ts
+++ /dev/null
@@ -1,168 +0,0 @@
-import { createAppAuth } from "@octokit/auth-app";
-import { Octokit, RequestError as OctokitRequestError } from "octokit";
-import type { fetch } from "undici";
-
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-import { createLogger } from "@homarr/core/infrastructure/logs";
-
-import { HandleIntegrationErrors } from "../base/errors/decorator";
-import { integrationOctokitHttpErrorHandler } from "../base/errors/http";
-import type { IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { ReleasesProviderIntegration } from "../interfaces/releases-providers/releases-providers-integration";
-import { getLatestRelease } from "../interfaces/releases-providers/releases-providers-integration";
-import type {
- DetailsProviderResponse,
- ReleaseProviderResponse,
- ReleaseResponse,
-} from "../interfaces/releases-providers/releases-providers-types";
-
-const logger = createLogger({ module: "githubIntegration" });
-
-@HandleIntegrationErrors([integrationOctokitHttpErrorHandler])
-export class GithubIntegration extends Integration implements ReleasesProviderIntegration {
- private static readonly userAgent = "Homarr-Lab/Homarr:GithubIntegration";
-
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const api = this.getApi(input.fetchAsync);
-
- if (this.hasSecretValue("personalAccessToken")) {
- await api.rest.users.getAuthenticated();
- } else if (this.hasSecretValue("githubAppId")) {
- await api.rest.apps.getInstallation({
- installation_id: Number(this.getSecretValue("githubInstallationId")),
- });
- } else {
- await api.request("GET /octocat");
- }
-
- return {
- success: true,
- };
- }
-
- private parseIdentifier(identifier: string) {
- const [owner, name] = identifier.split("/");
- if (!owner || !name) {
- logger.warn("Invalid identifier format. Expected 'owner/name' for identifier", {
- identifier,
- });
- return null;
- }
- return { owner, name };
- }
-
- public async getLatestMatchingReleaseAsync(identifier: string, versionRegex?: string): Promise {
- const parsedIdentifier = this.parseIdentifier(identifier);
- if (!parsedIdentifier) return { success: false, error: { code: "invalidIdentifier" } };
-
- const { owner, name } = parsedIdentifier;
- const api = this.getApi();
-
- try {
- const releasesResponse = await api.rest.repos.listReleases({ owner, repo: name });
-
- if (releasesResponse.data.length === 0) {
- logger.warn("No releases found", {
- identifier: `${owner}/${name}`,
- });
- return { success: false, error: { code: "noMatchingVersion" } };
- }
-
- const releasesProviderResponse = releasesResponse.data.reduce((acc, release) => {
- if (!release.published_at) return acc;
-
- acc.push({
- latestRelease: release.tag_name,
- latestReleaseAt: new Date(release.published_at),
- releaseUrl: release.html_url,
- releaseDescription: release.body ?? undefined,
- isPreRelease: release.prerelease,
- });
- return acc;
- }, []);
-
- const latestRelease = getLatestRelease(releasesProviderResponse, versionRegex);
- if (!latestRelease) return { success: false, error: { code: "noMatchingVersion" } };
-
- const details = await this.getDetailsAsync(api, owner, name);
-
- return { success: true, data: { ...details, ...latestRelease } };
- } catch (error) {
- const errorMessage = error instanceof OctokitRequestError ? error.message : String(error);
- logger.warn("Failed to get releases", {
- owner,
- name,
- error: errorMessage,
- });
- return { success: false, error: { code: "unexpected", message: errorMessage } };
- }
- }
-
- protected async getDetailsAsync(
- api: Octokit,
- owner: string,
- name: string,
- ): Promise {
- try {
- const response = await api.rest.repos.get({
- owner,
- repo: name,
- });
-
- return {
- projectUrl: response.data.html_url,
- projectDescription: response.data.description ?? undefined,
- isFork: response.data.fork,
- isArchived: response.data.archived,
- createdAt: new Date(response.data.created_at),
- starsCount: response.data.stargazers_count,
- openIssues: response.data.open_issues_count,
- forksCount: response.data.forks_count,
- };
- } catch (error) {
- logger.warn("Failed to get details", {
- owner,
- name,
- error: error instanceof OctokitRequestError ? error.message : String(error),
- });
- return undefined;
- }
- }
-
- private getAuthProperties(): Pick {
- if (this.hasSecretValue("personalAccessToken"))
- return {
- auth: this.getSecretValue("personalAccessToken"),
- };
-
- if (this.hasSecretValue("githubAppId"))
- return {
- authStrategy: createAppAuth,
- auth: {
- appId: this.getSecretValue("githubAppId"),
- installationId: this.getSecretValue("githubInstallationId"),
- privateKey: this.getSecretValue("privateKey"),
- } satisfies Parameters[0],
- };
-
- return {};
- }
-
- private getApi(customFetch?: typeof fetch) {
- return new Octokit({
- baseUrl: this.url("/").origin,
- request: {
- fetch: customFetch ?? fetchWithTrustedCertificatesAsync,
- },
- userAgent: GithubIntegration.userAgent,
- // Disable throttling for this integration, Octokit will retry by default after a set time,
- // thus delaying the repsonse to the user in case of errors. Errors will be shown to the user, no need to retry the request.
- throttle: { enabled: false },
- ...this.getAuthProperties(),
- });
- }
-}
-
-type OctokitOptions = Exclude[0], undefined>;
diff --git a/packages/integrations/src/gitlab/gitlab-integration.ts b/packages/integrations/src/gitlab/gitlab-integration.ts
deleted file mode 100644
index fd1ebc926..000000000
--- a/packages/integrations/src/gitlab/gitlab-integration.ts
+++ /dev/null
@@ -1,155 +0,0 @@
-import type { Gitlab as CoreGitlab } from "@gitbeaker/core";
-import { createRequesterFn, defaultOptionsHandler } from "@gitbeaker/requester-utils";
-import type { FormattedResponse, RequestOptions, ResourceOptions } from "@gitbeaker/requester-utils";
-import { Gitlab } from "@gitbeaker/rest";
-
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-import { createLogger } from "@homarr/core/infrastructure/logs";
-
-import type { IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import { TestConnectionError } from "../base/test-connection/test-connection-error";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { ReleasesProviderIntegration } from "../interfaces/releases-providers/releases-providers-integration";
-import { getLatestRelease } from "../interfaces/releases-providers/releases-providers-integration";
-import type {
- DetailsProviderResponse,
- ReleaseProviderResponse,
- ReleaseResponse,
-} from "../interfaces/releases-providers/releases-providers-types";
-
-const logger = createLogger({ module: "gitlabIntegration" });
-
-export class GitlabIntegration extends Integration implements ReleasesProviderIntegration {
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const response = await input.fetchAsync(this.url("/api/v4/projects"), {
- headers: {
- ...(this.hasSecretValue("personalAccessToken")
- ? { Authorization: `Bearer ${this.getSecretValue("personalAccessToken")}` }
- : {}),
- },
- });
-
- if (!response.ok) {
- return TestConnectionError.StatusResult(response);
- }
-
- return {
- success: true,
- };
- }
-
- public async getLatestMatchingReleaseAsync(identifier: string, versionRegex?: string): Promise {
- const api = this.getApi();
-
- try {
- const releasesResponse = await api.ProjectReleases.all(identifier, {
- perPage: 100,
- });
-
- if (releasesResponse instanceof Error) {
- logger.warn("No releases found", {
- identifier,
- error: releasesResponse.message,
- });
- return { success: false, error: { code: "noReleasesFound" } };
- }
-
- const releasesProviderResponse = releasesResponse.reduce((acc, release) => {
- if (!release.released_at) return acc;
-
- const releaseDate = new Date(release.released_at);
-
- acc.push({
- latestRelease: release.name ?? release.tag_name,
- latestReleaseAt: releaseDate,
- releaseUrl: release._links.self,
- releaseDescription: release.description ?? undefined,
- isPreRelease: releaseDate > new Date(), // For upcoming releases the `released_at` will be set to the future (https://docs.gitlab.com/api/releases/#upcoming-releases). Gitbreaker doesn't currently support the `upcoming_release` field (https://github.com/jdalrymple/gitbeaker/issues/3730)
- });
- return acc;
- }, []);
-
- const latestRelease = getLatestRelease(releasesProviderResponse, versionRegex);
- if (!latestRelease) return { success: false, error: { code: "noMatchingVersion" } };
-
- const details = await this.getDetailsAsync(api, identifier);
-
- return { success: true, data: { ...details, ...latestRelease } };
- } catch (error) {
- const errorMessage = error instanceof Error ? error.message : String(error);
- logger.warn("Failed to get releases", {
- identifier,
- error: errorMessage,
- });
- return { success: false, error: { code: "unexpected", message: errorMessage } };
- }
- }
-
- protected async getDetailsAsync(api: CoreGitlab, identifier: string): Promise {
- try {
- const response = await api.Projects.show(identifier);
-
- if (response instanceof Error) {
- logger.warn("Failed to get details", {
- identifier,
- error: response.message,
- });
-
- return undefined;
- }
-
- if (!response.web_url) {
- logger.warn("No web URL found", {
- identifier,
- });
- return undefined;
- }
-
- return {
- projectUrl: response.web_url,
- projectDescription: response.description ?? undefined,
- isFork: response.forked_from_project !== null,
- isArchived: response.archived,
- createdAt: new Date(response.created_at),
- starsCount: response.star_count,
- openIssues: response.open_issues_count,
- forksCount: response.forks_count,
- };
- } catch (error) {
- logger.warn("Failed to get details", {
- identifier,
- error: error instanceof Error ? error.message : String(error),
- });
-
- return undefined;
- }
- }
-
- private getApi() {
- return new Gitlab({
- host: this.url("/").origin,
- requesterFn: createRequesterFn(
- async (serviceOptions: ResourceOptions, _: RequestOptions) => await defaultOptionsHandler(serviceOptions),
- async (endpoint: string, options?: Record): Promise => {
- if (options === undefined) {
- throw new Error("Gitlab library is not configured correctly. Options must be provided.");
- }
-
- const response = await fetchWithTrustedCertificatesAsync(
- `${options.prefixUrl as string}${endpoint}`,
- options,
- );
- const headers = Object.fromEntries(response.headers.entries());
-
- return {
- status: response.status,
- headers,
- body: await response.json(),
- } as FormattedResponse;
- },
- ),
- ...(this.hasSecretValue("personalAccessToken") ? { token: this.getSecretValue("personalAccessToken") } : {}),
- });
- }
-}
diff --git a/packages/integrations/src/index.ts b/packages/integrations/src/index.ts
index 66cf4be51..8e20bf745 100644
--- a/packages/integrations/src/index.ts
+++ b/packages/integrations/src/index.ts
@@ -1,6 +1,6 @@
// General integrations
-export { AdGuardHomeIntegration } from "./adguard-home/adguard-home-integration";
export { ArchiveTeamWarriorIntegration } from "./archive-team-warrior/archive-team-warrior-integration";
+export { AdGuardHomeIntegration } from "./adguard-home/adguard-home-integration";
export { TechnitiumDnsIntegration } from "./technitium/technitium-integration";
export { AnchorIntegration } from "./anchor/anchor-integration";
export { Aria2Integration } from "./download-client/aria2/aria2-integration";
@@ -64,7 +64,6 @@ export type {
TdarrStatistics,
TdarrWorker,
} from "./interfaces/media-transcoding/media-transcoding-types";
-export type { ReleasesRepository, ReleaseResponse } from "./interfaces/releases-providers/releases-providers-types";
export type { Notification } from "./interfaces/notifications/notification-types";
export type { ImmichServerStats, ImmichAlbum, ImmichAsset } from "./immich/immich-integration";
export type { PaperlessNgxStats } from "./paperless-ngx/paperless-ngx-types";
@@ -75,17 +74,17 @@ export type {
AnchorNotesListInput,
AnchorNoteSummary,
} from "./anchor/anchor-types";
-export type {
- ArchiveTeamWarriorBandwidth,
- ArchiveTeamWarriorItem,
- ArchiveTeamWarriorStatus,
-} from "./archive-team-warrior/archive-team-warrior-types";
export type { TracearrDashboardData } from "./tracearr/tracearr-types";
export type { SpeedtestTrackerDashboardData } from "./speedtest-tracker/speedtest-tracker-types";
export type { AudiobookshelfDashboardData } from "./audiobookshelf/audiobookshelf-types";
export type { NavidromeDashboardData } from "./navidrome/navidrome-types";
export type { UptimeKumaDashboardData } from "./uptime-kuma/uptime-kuma-types";
export type { UmamiVisitorStats } from "./umami/umami-types";
+export type {
+ ArchiveTeamWarriorBandwidth,
+ ArchiveTeamWarriorItem,
+ ArchiveTeamWarriorStatus,
+} from "./archive-team-warrior/archive-team-warrior-types";
// Schemas
export { anchorNotesListInputSchema } from "./anchor/anchor-types";
diff --git a/packages/integrations/src/interfaces/releases-providers/releases-providers-integration.ts b/packages/integrations/src/interfaces/releases-providers/releases-providers-integration.ts
deleted file mode 100644
index e94f555fc..000000000
--- a/packages/integrations/src/interfaces/releases-providers/releases-providers-integration.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-import type { ReleaseProviderResponse, ReleaseResponse } from "./releases-providers-types";
-
-export const getLatestRelease = (
- releases: ReleaseProviderResponse[],
- versionRegex?: string,
-): ReleaseProviderResponse | null => {
- const validReleases = releases.filter((result) => {
- if (result.latestRelease) {
- return versionRegex ? new RegExp(versionRegex).test(result.latestRelease) : true;
- }
- return true;
- });
-
- return validReleases.length === 0
- ? null
- : validReleases.reduce((latest, current) => (current.latestReleaseAt > latest.latestReleaseAt ? current : latest));
-};
-
-export interface ReleasesProviderIntegration {
- getLatestMatchingReleaseAsync(identifier: string, versionRegex?: string): Promise;
-}
diff --git a/packages/integrations/src/interfaces/releases-providers/releases-providers-types.ts b/packages/integrations/src/interfaces/releases-providers/releases-providers-types.ts
deleted file mode 100644
index fb89b0fcb..000000000
--- a/packages/integrations/src/interfaces/releases-providers/releases-providers-types.ts
+++ /dev/null
@@ -1,34 +0,0 @@
-import type { TranslationObject } from "@homarr/translation";
-
-export interface ReleasesRepository extends Record {
- id: string;
- identifier: string;
- versionRegex?: string;
-}
-
-export interface DetailsProviderResponse {
- projectUrl?: string;
- projectDescription?: string;
- isFork?: boolean;
- isArchived?: boolean;
- createdAt?: Date;
- starsCount?: number;
- openIssues?: number;
- forksCount?: number;
-}
-
-export interface ReleaseProviderResponse {
- latestRelease: string;
- latestReleaseAt: Date;
- releaseUrl?: string;
- releaseDescription?: string;
- isPreRelease?: boolean;
-}
-
-type ReleasesErrorKeys = keyof TranslationObject["widget"]["releases"]["error"]["messages"];
-
-export type ReleaseData = DetailsProviderResponse & ReleaseProviderResponse;
-
-export type ReleaseError = { code: ReleasesErrorKeys } | { code: "unexpected"; message: string };
-
-export type ReleaseResponse = { success: true; data: ReleaseData } | { success: false; error: ReleaseError };
diff --git a/packages/integrations/src/interfaces/timetable/timetable-integration.ts b/packages/integrations/src/interfaces/timetable/timetable-integration.ts
deleted file mode 100644
index 74e9d3c02..000000000
--- a/packages/integrations/src/interfaces/timetable/timetable-integration.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-import type { Station, Timetable, TimetableOptions } from "./timetable-types";
-
-export interface TimetableIntegration {
- searchStationsAsync(query: string): Promise;
- getTimetableAsync(options: TimetableOptions): Promise;
-}
diff --git a/packages/integrations/src/interfaces/timetable/timetable-types.ts b/packages/integrations/src/interfaces/timetable/timetable-types.ts
deleted file mode 100644
index 72350b5a3..000000000
--- a/packages/integrations/src/interfaces/timetable/timetable-types.ts
+++ /dev/null
@@ -1,33 +0,0 @@
-import z from "zod";
-
-export interface Station {
- id: string;
- name: string;
-}
-
-export const timetableOptionsSchema = z.object({
- stationId: z.string(),
- limit: z.number().default(10),
-});
-
-export type TimetableOptions = z.infer;
-
-export interface TimetableEntry {
- timestamp: Date;
- delay: number;
- line: {
- name: string;
- color: string | null;
- } | null;
- location: string;
- platform: {
- name: string;
- hasChanged: boolean;
- } | null;
-}
-
-export interface Timetable {
- stationId: string;
- timestamp: Date;
- entries: TimetableEntry[];
-}
diff --git a/packages/integrations/src/linuxserverio/linuxserverio-integration.ts b/packages/integrations/src/linuxserverio/linuxserverio-integration.ts
deleted file mode 100644
index 3178f2c4b..000000000
--- a/packages/integrations/src/linuxserverio/linuxserverio-integration.ts
+++ /dev/null
@@ -1,73 +0,0 @@
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-import { createLogger } from "@homarr/core/infrastructure/logs";
-
-import type { IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import { TestConnectionError } from "../base/test-connection/test-connection-error";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { ReleasesProviderIntegration } from "../interfaces/releases-providers/releases-providers-integration";
-import type { ReleaseResponse } from "../interfaces/releases-providers/releases-providers-types";
-import { releasesResponseSchema } from "./linuxserverio-schemas";
-
-const logger = createLogger({ module: "linuxServerIOIntegration" });
-
-export class LinuxServerIOIntegration extends Integration implements ReleasesProviderIntegration {
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const response = await input.fetchAsync(this.url("/health"));
-
- if (!response.ok) {
- return TestConnectionError.StatusResult(response);
- }
-
- return {
- success: true,
- };
- }
-
- private parseIdentifier(identifier: string) {
- const [owner, name] = identifier.split("/");
- if (!owner || !name) {
- logger.warn("Invalid identifier format. Expected 'owner/name' for identifier", { identifier });
- return null;
- }
- return { owner, name };
- }
-
- public async getLatestMatchingReleaseAsync(identifier: string): Promise {
- const { name } = this.parseIdentifier(identifier) ?? {};
- if (!name) return { success: false, error: { code: "invalidIdentifier" } };
-
- const releasesResponse = await fetchWithTrustedCertificatesAsync(this.url("/api/v1/images"));
- if (!releasesResponse.ok) {
- return { success: false, error: { code: "unexpected", message: releasesResponse.statusText } };
- }
-
- const releasesResponseJson: unknown = await releasesResponse.json();
- const { data, success, error } = releasesResponseSchema.safeParse(releasesResponseJson);
- if (!success) {
- return { success: false, error: { code: "unexpected", message: error.message } };
- }
-
- const release = data.data.repositories.linuxserver.find((repo) => repo.name === name);
- if (!release) {
- logger.warn("Repository not found on provider", {
- name,
- });
- return { success: false, error: { code: "noMatchingVersion" } };
- }
-
- return {
- success: true,
- data: {
- latestRelease: release.version,
- latestReleaseAt: release.version_timestamp,
- releaseDescription: release.changelog?.shift()?.desc,
- projectUrl: release.github_url,
- projectDescription: release.description,
- isArchived: release.deprecated,
- createdAt: release.initial_date ? new Date(release.initial_date) : undefined,
- starsCount: release.stars,
- },
- };
- }
-}
diff --git a/packages/integrations/src/linuxserverio/linuxserverio-schemas.ts b/packages/integrations/src/linuxserverio/linuxserverio-schemas.ts
deleted file mode 100644
index 3e3653697..000000000
--- a/packages/integrations/src/linuxserverio/linuxserverio-schemas.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-import { z } from "zod/v4";
-
-export const releasesResponseSchema = z.object({
- data: z.object({
- repositories: z.object({
- linuxserver: z.array(
- z.object({
- name: z.string(),
- initial_date: z
- .string()
- .transform((value) => new Date(value))
- .optional(),
- github_url: z.string(),
- description: z.string(),
- version: z.string(),
- version_timestamp: z.string().transform((value) => new Date(value)),
- stars: z.number(),
- deprecated: z.boolean(),
- changelog: z
- .array(
- z.object({
- date: z.string().transform((value) => new Date(value)),
- desc: z.string(),
- }),
- )
- .optional(),
- }),
- ),
- }),
- }),
-});
diff --git a/packages/integrations/src/npm/npm-integration.ts b/packages/integrations/src/npm/npm-integration.ts
deleted file mode 100644
index b0c8c050b..000000000
--- a/packages/integrations/src/npm/npm-integration.ts
+++ /dev/null
@@ -1,56 +0,0 @@
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-
-import type { IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import { TestConnectionError } from "../base/test-connection/test-connection-error";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { ReleasesProviderIntegration } from "../interfaces/releases-providers/releases-providers-integration";
-import { getLatestRelease } from "../interfaces/releases-providers/releases-providers-integration";
-import type { ReleaseResponse } from "../interfaces/releases-providers/releases-providers-types";
-import { releasesResponseSchema } from "./npm-schemas";
-
-export class NPMIntegration extends Integration implements ReleasesProviderIntegration {
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const response = await input.fetchAsync(this.url("/"));
-
- if (!response.ok) {
- return TestConnectionError.StatusResult(response);
- }
-
- return {
- success: true,
- };
- }
-
- public async getLatestMatchingReleaseAsync(identifier: string, versionRegex?: string): Promise {
- if (!identifier) return { success: false, error: { code: "invalidIdentifier" } };
-
- const releasesResponse = await fetchWithTrustedCertificatesAsync(this.url(`/${encodeURIComponent(identifier)}`));
- if (!releasesResponse.ok) {
- return { success: false, error: { code: "unexpected", message: releasesResponse.statusText } };
- }
-
- const releasesResponseJson: unknown = await releasesResponse.json();
- const { data, success, error } = releasesResponseSchema.safeParse(releasesResponseJson);
- if (!success) {
- return {
- success: false,
- error: {
- code: "unexpected",
- message: releasesResponseJson ? JSON.stringify(releasesResponseJson, null, 2) : error.message,
- },
- };
- }
-
- const formattedReleases = data.time.map((tag) => ({
- ...tag,
- releaseUrl: `https://www.npmjs.com/package/${encodeURIComponent(data.name)}/v/${encodeURIComponent(tag.latestRelease)}`,
- releaseDescription: data.versions[tag.latestRelease]?.description ?? "",
- }));
-
- const latestRelease = getLatestRelease(formattedReleases, versionRegex);
- if (!latestRelease) return { success: false, error: { code: "noMatchingVersion" } };
-
- return { success: true, data: latestRelease };
- }
-}
diff --git a/packages/integrations/src/npm/npm-schemas.ts b/packages/integrations/src/npm/npm-schemas.ts
deleted file mode 100644
index 5d21734e2..000000000
--- a/packages/integrations/src/npm/npm-schemas.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-import { z } from "zod/v4";
-
-export const releasesResponseSchema = z.object({
- time: z
- .record(
- z.string(),
- z.string().transform((value) => new Date(value)),
- )
- .transform((version) =>
- Object.entries(version).map(([key, value]) => ({
- latestRelease: key,
- latestReleaseAt: value,
- })),
- ),
- versions: z.record(z.string(), z.object({ description: z.string() })),
- name: z.string(),
-});
diff --git a/packages/integrations/src/quay/quay-integration.ts b/packages/integrations/src/quay/quay-integration.ts
deleted file mode 100644
index 21cbf797e..000000000
--- a/packages/integrations/src/quay/quay-integration.ts
+++ /dev/null
@@ -1,97 +0,0 @@
-import type { RequestInit, Response } from "undici";
-
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-import { createLogger } from "@homarr/core/infrastructure/logs";
-
-import type { IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import { TestConnectionError } from "../base/test-connection/test-connection-error";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { ReleasesProviderIntegration } from "../interfaces/releases-providers/releases-providers-integration";
-import { getLatestRelease } from "../interfaces/releases-providers/releases-providers-integration";
-import type {
- ReleaseProviderResponse,
- ReleaseResponse,
-} from "../interfaces/releases-providers/releases-providers-types";
-import { releasesResponseSchema } from "./quay-schemas";
-
-const logger = createLogger({ module: "quayIntegration" });
-
-export class QuayIntegration extends Integration implements ReleasesProviderIntegration {
- private async withHeadersAsync(callback: (headers: RequestInit["headers"]) => Promise): Promise {
- if (!this.hasSecretValue("personalAccessToken")) return await callback(undefined);
-
- return await callback({
- Authorization: `token ${this.getSecretValue("personalAccessToken")}`,
- });
- }
-
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const response = await this.withHeadersAsync(async (headers) => {
- return await input.fetchAsync(this.url("/api/v1/discovery"), {
- headers,
- });
- });
-
- if (!response.ok) {
- return TestConnectionError.StatusResult(response);
- }
-
- return {
- success: true,
- };
- }
-
- private parseIdentifier(identifier: string) {
- const [owner, name] = identifier.split("/");
- if (!owner || !name) {
- logger.warn("Invalid identifier format. Expected 'owner/name' for identifier", {
- identifier,
- });
- return null;
- }
- return { owner, name };
- }
-
- public async getLatestMatchingReleaseAsync(identifier: string, versionRegex?: string): Promise {
- const parsedIdentifier = this.parseIdentifier(identifier);
- if (!parsedIdentifier) return { success: false, error: { code: "invalidIdentifier" } };
-
- const { owner, name } = parsedIdentifier;
-
- const releasesResponse = await this.withHeadersAsync(async (headers) => {
- return await fetchWithTrustedCertificatesAsync(
- this.url(
- `/api/v1/repository/${encodeURIComponent(owner)}/${encodeURIComponent(name)}?includeTags=true&includeStats=true`,
- ),
- {
- headers,
- },
- );
- });
- if (!releasesResponse.ok) {
- return { success: false, error: { code: "unexpected", message: releasesResponse.statusText } };
- }
-
- const releasesResponseJson: unknown = await releasesResponse.json();
- const { data, success, error } = releasesResponseSchema.safeParse(releasesResponseJson);
- if (!success) {
- return { success: false, error: { code: "unexpected", message: error.message } };
- }
-
- const releasesProviderResponse = Object.entries(data.tags).reduce((acc, [_, tag]) => {
- if (!tag.name || !tag.last_modified) return acc;
- acc.push({
- latestRelease: tag.name,
- latestReleaseAt: new Date(tag.last_modified),
- releaseUrl: `https://quay.io/repository/${encodeURIComponent(owner)}/${encodeURIComponent(name)}/tag/${encodeURIComponent(tag.name)}`,
- });
- return acc;
- }, []);
-
- const latestRelease = getLatestRelease(releasesProviderResponse, versionRegex);
- if (!latestRelease) return { success: false, error: { code: "noMatchingVersion" } };
-
- return { success: true, data: { projectDescription: data.description, ...latestRelease } };
- }
-}
diff --git a/packages/integrations/src/quay/quay-schemas.ts b/packages/integrations/src/quay/quay-schemas.ts
deleted file mode 100644
index e24fe2d83..000000000
--- a/packages/integrations/src/quay/quay-schemas.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { z } from "zod/v4";
-
-export const releasesResponseSchema = z.object({
- description: z.string().optional(),
- tags: z.record(
- z.string(),
- z.object({
- name: z.string(),
- last_modified: z.string(),
- }),
- ),
-});
diff --git a/packages/integrations/src/search-ch/search-ch-integration.ts b/packages/integrations/src/search-ch/search-ch-integration.ts
deleted file mode 100644
index cbaf8e80d..000000000
--- a/packages/integrations/src/search-ch/search-ch-integration.ts
+++ /dev/null
@@ -1,141 +0,0 @@
-import z from "zod";
-
-import { ResponseError } from "@homarr/common/server";
-import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-
-import type { IntegrationTestingInput } from "../base/integration";
-import { Integration } from "../base/integration";
-import { TestConnectionError } from "../base/test-connection/test-connection-error";
-import type { TestingResult } from "../base/test-connection/test-connection-service";
-import type { TimetableIntegration } from "../interfaces/timetable/timetable-integration";
-import type { Station, Timetable, TimetableOptions } from "../interfaces/timetable/timetable-types";
-
-const supportedStationTypes = ["bus", "tram", "train", "ship", "cablecar", "funicular", "chairlift"];
-
-export class SearchChIntegration extends Integration implements TimetableIntegration {
- protected async testingAsync(input: IntegrationTestingInput): Promise {
- const response = await input.fetchAsync(this.url("/timetable/api/completion.json", { term: "Zürich" }));
-
- if (!response.ok) {
- return TestConnectionError.StatusResult(response);
- }
-
- return {
- success: true,
- };
- }
-
- /**
- * Searches for stations matching the given query.
- * @param query The search query for station names.
- * @returns A list of stations matching the search query.
- * @docs https://search.ch/fahrplan/api/help
- */
- public async searchStationsAsync(query: string): Promise {
- const response = await fetchWithTrustedCertificatesAsync(
- this.url("/timetable/api/completion.json", {
- term: query,
- show_ids: 1,
- nofavorites: 1,
- }),
- );
-
- if (!response.ok) {
- throw new ResponseError(response);
- }
-
- const data = await searchSchema.parseAsync(await response.json());
-
- return (
- data
- // Remove completions like addresses, we only want stations.
- .filter((item) => supportedStationTypes.some((type) => item.iconclass.endsWith(type)))
- .map((item) => (item.id !== undefined ? { id: item.id, name: item.label } : null))
- .filter((item) => item !== null)
- );
- }
-
- /**
- * Gets the departure timetable for a given station.
- * @param options Timetable options including station ID and limit.
- * @returns timetable for the given station.
- * @docs https://search.ch/fahrplan/api/help
- */
- public async getTimetableAsync(options: TimetableOptions): Promise {
- const now = new Date();
- // The following format is used [01.01.2000, 23:59:00]. The API allows usage of DD.MM.YYYY format and HH:mm format
- const [date, time] = now.toLocaleString("en-CH", { timeZone: "Europe/Zurich" }).split(", ") as [string, string];
-
- const response = await fetchWithTrustedCertificatesAsync(
- this.url("/timetable/api/stationboard.json", {
- stop: options.stationId,
- limit: options.limit,
- show_delays: 1,
- show_tracks: 1,
- date,
- time: time.substring(0, 5), // Only keep the HH:mm part of the time, as that's what the API expects
- }),
- );
-
- if (!response.ok) {
- throw new ResponseError(response);
- }
-
- const data = await timetableSchema.parseAsync(await response.json());
-
- return {
- stationId: options.stationId,
- timestamp: now,
- entries: data.connections.map((connection) => {
- // Color is in format A35~F10~ for foreground and background color. Some only have ~~ and therefore no color
- const color = connection.color.split("~")[0];
-
- return {
- timestamp: connection.time,
- line: connection.line
- ? {
- name: connection.line,
- color: color && color.length >= 1 ? `#${color}` : null,
- }
- : null,
- location: connection.terminal.name,
- delay: connection.dep_delay,
- platform: connection.track
- ? {
- // If the track name contains "!", it indicates a change in the track
- // so we remove the "!" from the name and set hasChanged to true
- name: connection.track.replace("!", ""),
- hasChanged: connection.track.includes("!"),
- }
- : null,
- };
- }),
- };
- }
-}
-
-const timetableSchema = z.object({
- connections: z.array(
- z.object({
- time: z.string().transform((str) => new Date(str)),
- line: z.string().optional(),
- color: z.string(),
- terminal: z.object({
- name: z.string(),
- }),
- track: z.string().optional(),
- dep_delay: z
- .string()
- .optional()
- .transform((str) => (str ? parseInt(str) : 0)),
- }),
- ),
-});
-
-const searchSchema = z.array(
- z.object({
- id: z.string().optional(),
- label: z.string(),
- iconclass: z.string(), // This is in format sl-icon-type-{type}
- }),
-);
diff --git a/packages/integrations/src/types.ts b/packages/integrations/src/types.ts
index afeaf1db2..273b5b2d2 100644
--- a/packages/integrations/src/types.ts
+++ b/packages/integrations/src/types.ts
@@ -15,7 +15,6 @@ export * from "./opnsense/opnsense-types";
export * from "./interfaces/media-releases";
export * from "./coolify/coolify-types";
export * from "./anchor/anchor-types";
-export * from "./interfaces/timetable/timetable-types";
export * from "./tracearr/tracearr-types";
export * from "./speedtest-tracker/speedtest-tracker-types";
export * from "./uptime-kuma/uptime-kuma-types";
diff --git a/packages/request-handler/src/release-providers.ts b/packages/request-handler/src/release-providers.ts
new file mode 100644
index 000000000..8d918b761
--- /dev/null
+++ b/packages/request-handler/src/release-providers.ts
@@ -0,0 +1,829 @@
+import { Octokit, RequestError as OctokitRequestError } from "octokit";
+import { z } from "zod/v4";
+
+import type { ReleaseProviderKind } from "@homarr/definitions";
+import { getReleaseProviderDefaultUrl, normalizeReleaseProviderIdentifier } from "@homarr/definitions";
+import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
+import { createLogger } from "@homarr/core/infrastructure/logs";
+
+const logger = createLogger({ module: "releaseProviders" });
+
+const PROVIDER_TIMEOUT_MS = 10_000;
+const fetchProvider = (url: URL | RequestInfo, options?: RequestInit & { timeout?: number }) =>
+ fetchWithTrustedCertificatesAsync(url, { timeout: PROVIDER_TIMEOUT_MS, ...options });
+
+export interface ReleasesRepositoryRequest extends Record {
+ id: string;
+ provider: ReleaseProviderKind;
+ identifier: string;
+ versionRegex?: string;
+ providerUrl?: string;
+ token?: string;
+}
+
+export interface DetailsProviderResponse {
+ projectUrl?: string;
+ projectDescription?: string;
+ isFork?: boolean;
+ isArchived?: boolean;
+ createdAt?: Date;
+ starsCount?: number;
+ openIssues?: number;
+ forksCount?: number;
+}
+
+export interface ReleaseProviderResponse {
+ latestRelease: string;
+ latestReleaseAt: Date;
+ releaseUrl?: string;
+ releaseDescription?: string;
+ isPreRelease?: boolean;
+}
+
+export type ReleaseData = DetailsProviderResponse & ReleaseProviderResponse;
+export type ReleaseError = {
+ code: "invalidIdentifier" | "noMatchingVersion" | "noReleasesFound" | "unexpected";
+ message: string;
+};
+export type ReleaseResponse = { success: true; data: ReleaseData } | { success: false; error: ReleaseError };
+
+const compileVersionRegex = (versionRegex?: string): RegExp | null => {
+ if (!versionRegex) return null;
+ try {
+ return new RegExp(versionRegex);
+ } catch {
+ return null;
+ }
+};
+
+export const getLatestRelease = (
+ releases: ReleaseProviderResponse[],
+ versionRegex?: string,
+): { release: ReleaseProviderResponse } | { noMatch: string } => {
+ const regex = compileVersionRegex(versionRegex);
+ if (versionRegex && !regex) {
+ return { noMatch: `Invalid regex: /${versionRegex}/` };
+ }
+
+ const validReleases = releases.filter((result) => {
+ if (!result.latestRelease) return false;
+ return regex ? regex.test(result.latestRelease) : true;
+ });
+
+ if (validReleases.length > 0) {
+ return {
+ release: validReleases.reduce((latest, current) =>
+ current.latestReleaseAt > latest.latestReleaseAt ? current : latest,
+ ),
+ };
+ }
+
+ const sampleTags = releases
+ .slice(0, 5)
+ .map((r) => r.latestRelease)
+ .join(", ");
+ const reason = versionRegex
+ ? `Regex /${versionRegex}/ matched 0/${releases.length} tags. Sample tags: [${sampleTags}]`
+ : `Found ${releases.length} releases but none had a valid tag`;
+ return { noMatch: reason };
+};
+
+export const getLatestMatchingReleaseAsync = async (input: ReleasesRepositoryRequest): Promise => {
+ const baseUrl = removeTrailingSlash(input.providerUrl ?? getReleaseProviderDefaultUrl(input.provider));
+ const identifier = normalizeReleaseProviderIdentifier(input.provider, input.identifier);
+
+ switch (input.provider) {
+ case "github":
+ return await getGithubReleaseAsync(baseUrl, identifier, input.versionRegex, input.token);
+ case "gitHubContainerRegistry":
+ return await getGitHubContainerRegistryReleaseAsync(baseUrl, identifier, input.versionRegex, input.token);
+ case "dockerHub":
+ return await getDockerHubReleaseAsync(baseUrl, identifier, input.versionRegex, input.token);
+ case "gitlab":
+ return await getGitlabReleaseAsync(baseUrl, identifier, input.versionRegex, input.token);
+ case "npm":
+ return await getNpmReleaseAsync(baseUrl, identifier, input.versionRegex, input.token);
+ case "codeberg":
+ return await getCodebergReleaseAsync(baseUrl, identifier, input.versionRegex, input.token);
+ case "linuxServerIO":
+ return await getLinuxServerIOReleaseAsync(baseUrl, identifier, input.versionRegex);
+ case "quay":
+ return await getQuayReleaseAsync(baseUrl, identifier, input.versionRegex);
+ }
+};
+
+const parseOwnerName = (identifier: string) => {
+ const [owner, name] = identifier.split("/");
+ if (!owner || !name) return null;
+ return { owner, name };
+};
+
+const parseOwnerPackageName = (identifier: string) => {
+ const [owner, ...nameParts] = identifier.split("/");
+ const name = nameParts.join("/");
+ if (!owner || !name) return null;
+ return { owner, name };
+};
+
+const removeTrailingSlash = (url: string) => url.replace(/\/$/, "");
+
+const buildUrl = (baseUrl: string, path: `/${string}`) => new URL(`${baseUrl}${path}`);
+
+const getGithubApi = (baseUrl: string, userAgent: string, token?: string) =>
+ new Octokit({
+ baseUrl,
+ auth: token,
+ request: { fetch: fetchWithTrustedCertificatesAsync },
+ throttle: { enabled: false },
+ userAgent,
+ });
+
+const getGithubReleaseAsync = async (
+ baseUrl: string,
+ identifier: string,
+ versionRegex?: string,
+ token?: string,
+): Promise => {
+ const parsed = parseOwnerName(identifier);
+ if (!parsed)
+ return {
+ success: false,
+ error: { code: "invalidIdentifier", message: `Cannot parse "${identifier}" as owner/repo` },
+ };
+
+ const api = getGithubApi(baseUrl, "Homarr-Lab/Homarr:GithubReleaseProvider", token);
+ try {
+ const allReleases = await api.paginate(api.rest.repos.listReleases, {
+ owner: parsed.owner,
+ repo: parsed.name,
+ per_page: 100,
+ });
+ if (allReleases.length === 0) {
+ return { success: false, error: { code: "noReleasesFound", message: `${identifier} has no GitHub releases` } };
+ }
+
+ const releases = allReleases.reduce((acc, release) => {
+ if (!release.published_at) return acc;
+ acc.push({
+ latestRelease: release.tag_name,
+ latestReleaseAt: new Date(release.published_at),
+ releaseUrl: release.html_url,
+ releaseDescription: release.body ?? undefined,
+ isPreRelease: release.prerelease,
+ });
+ return acc;
+ }, []);
+ const result = getLatestRelease(releases, versionRegex);
+ if ("noMatch" in result) {
+ return { success: false, error: { code: "noMatchingVersion", message: result.noMatch } };
+ }
+
+ const details = await getGithubDetailsAsync(api, parsed.owner, parsed.name);
+ return { success: true, data: { ...details, ...result.release } };
+ } catch (error) {
+ const message = error instanceof OctokitRequestError ? error.message : String(error);
+ logger.warn("Failed to get GitHub releases", { identifier, error: message });
+ return { success: false, error: { code: "unexpected", message } };
+ }
+};
+
+const getGithubDetailsAsync = async (api: Octokit, owner: string, name: string): Promise => {
+ try {
+ const response = await api.rest.repos.get({ owner, repo: name });
+ return {
+ projectUrl: response.data.html_url,
+ projectDescription: response.data.description ?? undefined,
+ isFork: response.data.fork,
+ isArchived: response.data.archived,
+ createdAt: new Date(response.data.created_at),
+ starsCount: response.data.stargazers_count,
+ openIssues: response.data.open_issues_count,
+ forksCount: response.data.forks_count,
+ };
+ } catch (error) {
+ logger.warn("Failed to get GitHub details", { owner, name, error: String(error) });
+ return {};
+ }
+};
+
+const getGitHubContainerRegistryReleaseAsync = async (
+ baseUrl: string,
+ identifier: string,
+ versionRegex?: string,
+ token?: string,
+): Promise => {
+ const parsed = parseOwnerPackageName(identifier);
+ if (!parsed)
+ return {
+ success: false,
+ error: { code: "invalidIdentifier", message: `Cannot parse "${identifier}" as owner/package` },
+ };
+
+ try {
+ const repositoryName = `${parsed.owner}/${parsed.name}`;
+ const regex = compileVersionRegex(versionRegex);
+ if (versionRegex && !regex) {
+ return { success: false, error: { code: "noMatchingVersion", message: `Invalid regex: /${versionRegex}/` } };
+ }
+ const registryUrl = new URL(baseUrl);
+ const registryToken = token ?? (await getGitHubContainerRegistryTokenAsync(registryUrl, repositoryName));
+ const tags = await getGitHubContainerRegistryTagsAsync(registryUrl, repositoryName, registryToken);
+ if (tags.length === 0) {
+ return { success: false, error: { code: "noReleasesFound", message: `${repositoryName} has no container tags` } };
+ }
+ const matchingTags = regex ? tags.filter((tag) => regex.test(tag)) : tags;
+ const tagsToCheck = versionRegex
+ ? matchingTags.slice(-100)
+ : matchingTags.includes("latest")
+ ? ["latest"]
+ : matchingTags.slice(-100);
+ if (tagsToCheck.length === 0) {
+ const sampleTags = tags.slice(0, 5).join(", ");
+ const msg = versionRegex
+ ? `Regex /${versionRegex}/ matched 0/${tags.length} tags. Sample: [${sampleTags}]`
+ : `No "latest" tag found among ${tags.length} tags. Sample: [${sampleTags}]`;
+ return { success: false, error: { code: "noMatchingVersion", message: msg } };
+ }
+
+ const releases = await Promise.all(
+ tagsToCheck.map(async (tag) => ({
+ latestRelease: tag,
+ latestReleaseAt: await getGitHubContainerRegistryTagCreatedAtAsync(
+ registryUrl,
+ repositoryName,
+ tag,
+ registryToken,
+ ),
+ releaseUrl: `https://github.com/${repositoryName}/pkgs/container/${encodeURIComponent(parsed.name)}`,
+ })),
+ );
+ const result = getLatestRelease(releases, versionRegex);
+ if ("noMatch" in result) {
+ return { success: false, error: { code: "noMatchingVersion", message: result.noMatch } };
+ }
+
+ return {
+ success: true,
+ data: {
+ projectUrl: `https://github.com/${repositoryName}`,
+ ...result.release,
+ },
+ };
+ } catch (error) {
+ const message = error instanceof Error ? error.message : String(error);
+ logger.warn("Failed to get GitHub container registry releases", { identifier, error: message });
+ return { success: false, error: { code: "unexpected", message } };
+ }
+};
+
+const gitHubContainerRegistryTokenSchema = z.object({ token: z.string() });
+const gitHubContainerRegistryTagsSchema = z.object({ tags: z.array(z.string()).optional() });
+const gitHubContainerRegistryManifestSchema = z.object({
+ config: z.object({ digest: z.string() }).optional(),
+ manifests: z.array(z.object({ digest: z.string() })).optional(),
+});
+const gitHubContainerRegistryConfigSchema = z.object({
+ created: z.string().transform((value) => new Date(value)),
+});
+
+const getGitHubContainerRegistryTokenAsync = async (registryUrl: URL, repositoryName: string) => {
+ const response = await fetchProvider(
+ buildUrl(
+ registryUrl.origin,
+ `/token?service=${registryUrl.host}&scope=${encodeURIComponent(`repository:${repositoryName}:pull`)}` as `/${string}`,
+ ),
+ );
+ if (!response.ok) throw new Error(response.statusText);
+
+ const result = gitHubContainerRegistryTokenSchema.safeParse(await response.json());
+ if (!result.success) throw new Error(result.error.message);
+
+ return result.data.token;
+};
+
+const getGitHubContainerRegistryTagsAsync = async (registryUrl: URL, repositoryName: string, token: string) => {
+ const response = await fetchProvider(buildUrl(registryUrl.origin, `/v2/${repositoryName}/tags/list`), {
+ headers: { Authorization: `Bearer ${token}` },
+ });
+ if (!response.ok) throw new Error(response.statusText);
+
+ const result = gitHubContainerRegistryTagsSchema.safeParse(await response.json());
+ if (!result.success) throw new Error(result.error.message);
+
+ return result.data.tags ?? [];
+};
+
+const getGitHubContainerRegistryTagCreatedAtAsync = async (
+ registryUrl: URL,
+ repositoryName: string,
+ tag: string,
+ token: string,
+) => {
+ const manifest = await getGitHubContainerRegistryManifestAsync(registryUrl, repositoryName, tag, token);
+ const imageManifest = manifest.config
+ ? manifest
+ : await getGitHubContainerRegistryManifestAsync(
+ registryUrl,
+ repositoryName,
+ manifest.manifests?.[0]?.digest ?? "",
+ token,
+ );
+ const configDigest = imageManifest.config?.digest;
+ if (!configDigest) throw new Error("Missing image config digest");
+
+ const response = await fetchProvider(buildUrl(registryUrl.origin, `/v2/${repositoryName}/blobs/${configDigest}`), {
+ headers: { Authorization: `Bearer ${token}` },
+ });
+ if (!response.ok) throw new Error(response.statusText);
+
+ const result = gitHubContainerRegistryConfigSchema.safeParse(await response.json());
+ if (!result.success) throw new Error(result.error.message);
+
+ return result.data.created;
+};
+
+const getGitHubContainerRegistryManifestAsync = async (
+ registryUrl: URL,
+ repositoryName: string,
+ reference: string,
+ token: string,
+) => {
+ if (!reference) throw new Error("Missing image manifest reference");
+
+ const response = await fetchProvider(buildUrl(registryUrl.origin, `/v2/${repositoryName}/manifests/${reference}`), {
+ headers: {
+ Authorization: `Bearer ${token}`,
+ Accept: [
+ "application/vnd.oci.image.index.v1+json",
+ "application/vnd.docker.distribution.manifest.list.v2+json",
+ "application/vnd.oci.image.manifest.v1+json",
+ "application/vnd.docker.distribution.manifest.v2+json",
+ ].join(", "),
+ },
+ });
+ if (!response.ok) throw new Error(response.statusText);
+
+ const result = gitHubContainerRegistryManifestSchema.safeParse(await response.json());
+ if (!result.success) throw new Error(result.error.message);
+
+ return result.data;
+};
+
+const dockerHubReleasesSchema = z.object({
+ results: z.array(
+ z.object({ name: z.string(), last_updated: z.string().transform((value) => new Date(value)) }).transform((tag) => ({
+ latestRelease: tag.name,
+ latestReleaseAt: tag.last_updated,
+ })),
+ ),
+});
+
+const dockerHubDetailsSchema = z.object({
+ name: z.string(),
+ namespace: z.string(),
+ description: z.string(),
+ star_count: z.number(),
+ date_registered: z.string().transform((value) => new Date(value)),
+});
+
+const getDockerHubReleaseAsync = async (
+ baseUrl: string,
+ identifier: string,
+ versionRegex?: string,
+ token?: string,
+): Promise => {
+ const parsed = identifier.includes("/") ? parseOwnerName(identifier) : { owner: "", name: identifier };
+ if (!parsed) return { success: false, error: { code: "invalidIdentifier", message: `Cannot parse "${identifier}"` } };
+
+ const relativeUrl = parsed.owner
+ ? `/v2/namespaces/${encodeURIComponent(parsed.owner)}/repositories/${encodeURIComponent(parsed.name)}`
+ : `/v2/repositories/library/${encodeURIComponent(parsed.name)}`;
+
+ const headers: Record = {};
+ if (token) headers.Authorization = `Bearer ${token}`;
+
+ let lastNoMatch = "";
+ for (let page = 0; page <= 5; page++) {
+ const response = await fetchProvider(
+ buildUrl(baseUrl, `${relativeUrl}/tags?page_size=100&page=${page}` as `/${string}`),
+ headers.Authorization ? { headers } : undefined,
+ );
+ if (!response.ok)
+ return {
+ success: false,
+ error: { code: "unexpected", message: `Docker Hub ${response.status}: ${response.statusText}` },
+ };
+
+ const json: unknown = await response.json();
+ const result = dockerHubReleasesSchema.safeParse(json);
+ if (!result.success) return { success: false, error: { code: "unexpected", message: result.error.message } };
+
+ const matched = getLatestRelease(result.data.results, versionRegex);
+ if ("noMatch" in matched) {
+ lastNoMatch = matched.noMatch;
+ continue;
+ }
+
+ const details = await getDockerHubDetailsAsync(baseUrl, relativeUrl as `/${string}`, token);
+ return { success: true, data: { ...details, ...matched.release } };
+ }
+
+ return {
+ success: false,
+ error: { code: "noMatchingVersion", message: lastNoMatch || `No matching tags found for ${identifier}` },
+ };
+};
+
+const getDockerHubDetailsAsync = async (
+ baseUrl: string,
+ relativeUrl: `/${string}`,
+ token?: string,
+): Promise => {
+ const headers: Record = {};
+ if (token) headers.Authorization = `Bearer ${token}`;
+
+ const response = await fetchProvider(
+ buildUrl(baseUrl, `${relativeUrl}/` as `/${string}`),
+ headers.Authorization ? { headers } : undefined,
+ );
+ if (!response.ok) return {};
+
+ const result = dockerHubDetailsSchema.safeParse(await response.json());
+ if (!result.success) return {};
+
+ return {
+ projectUrl: `https://hub.docker.com/r/${result.data.namespace}/${result.data.name}`,
+ projectDescription: result.data.description,
+ createdAt: result.data.date_registered,
+ starsCount: result.data.star_count,
+ };
+};
+
+const gitlabReleasesSchema = z.array(
+ z.object({
+ name: z.string().nullable().optional(),
+ tag_name: z.string(),
+ released_at: z.string().nullable().optional(),
+ description: z.string().nullable().optional(),
+ _links: z.object({ self: z.string().optional() }).optional(),
+ }),
+);
+
+const gitlabDetailsSchema = z.object({
+ web_url: z.string().optional(),
+ description: z.string().nullable().optional(),
+ forked_from_project: z.unknown().nullable().optional(),
+ archived: z.boolean(),
+ created_at: z.string(),
+ star_count: z.number(),
+ open_issues_count: z.number().optional(),
+ forks_count: z.number(),
+});
+
+const getGitlabReleaseAsync = async (
+ baseUrl: string,
+ identifier: string,
+ versionRegex?: string,
+ token?: string,
+): Promise => {
+ const encodedIdentifier = encodeURIComponent(identifier);
+ const headers: Record = {};
+ if (token) headers["PRIVATE-TOKEN"] = token;
+
+ const response = await fetchProvider(
+ buildUrl(baseUrl, `/api/v4/projects/${encodedIdentifier}/releases?per_page=100`),
+ headers["PRIVATE-TOKEN"] ? { headers } : undefined,
+ );
+ if (!response.ok)
+ return {
+ success: false,
+ error: { code: "unexpected", message: `GitLab ${response.status}: ${response.statusText}` },
+ };
+
+ const result = gitlabReleasesSchema.safeParse(await response.json());
+ if (!result.success) return { success: false, error: { code: "unexpected", message: result.error.message } };
+ if (result.data.length === 0)
+ return { success: false, error: { code: "noReleasesFound", message: `${identifier} has no GitLab releases` } };
+
+ const releases = result.data.reduce((acc, release) => {
+ if (!release.released_at) return acc;
+ const releaseDate = new Date(release.released_at);
+ acc.push({
+ latestRelease: release.tag_name,
+ latestReleaseAt: releaseDate,
+ releaseUrl: release._links?.self,
+ releaseDescription: release.description ?? undefined,
+ isPreRelease: releaseDate > new Date(),
+ });
+ return acc;
+ }, []);
+ const matched = getLatestRelease(releases, versionRegex);
+ if ("noMatch" in matched) return { success: false, error: { code: "noMatchingVersion", message: matched.noMatch } };
+
+ const details = await getGitlabDetailsAsync(baseUrl, encodedIdentifier, token);
+ return { success: true, data: { ...details, ...matched.release } };
+};
+
+const getGitlabDetailsAsync = async (
+ baseUrl: string,
+ encodedIdentifier: string,
+ token?: string,
+): Promise => {
+ const headers: Record = {};
+ if (token) headers["PRIVATE-TOKEN"] = token;
+
+ const response = await fetchProvider(
+ buildUrl(baseUrl, `/api/v4/projects/${encodedIdentifier}`),
+ headers["PRIVATE-TOKEN"] ? { headers } : undefined,
+ );
+ if (!response.ok) return {};
+
+ const result = gitlabDetailsSchema.safeParse(await response.json());
+ if (!result.success || !result.data.web_url) return {};
+
+ return {
+ projectUrl: result.data.web_url,
+ projectDescription: result.data.description ?? undefined,
+ isFork: result.data.forked_from_project !== null,
+ isArchived: result.data.archived,
+ createdAt: new Date(result.data.created_at),
+ starsCount: result.data.star_count,
+ openIssues: result.data.open_issues_count,
+ forksCount: result.data.forks_count,
+ };
+};
+
+const npmTimeMetadataKeys = new Set(["created", "modified"]);
+
+const npmReleasesSchema = z.object({
+ time: z
+ .record(
+ z.string(),
+ z.string().transform((value) => new Date(value)),
+ )
+ .transform((entries) =>
+ Object.entries(entries)
+ .filter(([key]) => !npmTimeMetadataKeys.has(key))
+ .map(([key, value]) => ({ latestRelease: key, latestReleaseAt: value })),
+ ),
+ versions: z.record(z.string(), z.object({ description: z.string().optional() })),
+ name: z.string(),
+});
+
+const getNpmReleaseAsync = async (
+ baseUrl: string,
+ identifier: string,
+ versionRegex?: string,
+ token?: string,
+): Promise => {
+ if (!identifier) return { success: false, error: { code: "invalidIdentifier", message: "Empty npm package name" } };
+
+ const headers: Record = {};
+ if (token) headers.Authorization = `Bearer ${token}`;
+
+ const response = await fetchProvider(
+ buildUrl(baseUrl, `/${encodeURIComponent(identifier)}`),
+ headers.Authorization ? { headers } : undefined,
+ );
+ if (!response.ok)
+ return { success: false, error: { code: "unexpected", message: `npm ${response.status}: ${response.statusText}` } };
+
+ const result = npmReleasesSchema.safeParse(await response.json());
+ if (!result.success) return { success: false, error: { code: "unexpected", message: result.error.message } };
+
+ const releases = result.data.time.map((tag) => ({
+ ...tag,
+ releaseUrl: `https://www.npmjs.com/package/${encodeURIComponent(result.data.name)}/v/${encodeURIComponent(tag.latestRelease)}`,
+ releaseDescription: result.data.versions[tag.latestRelease]?.description ?? "",
+ }));
+ const matched = getLatestRelease(releases, versionRegex);
+ if ("noMatch" in matched) return { success: false, error: { code: "noMatchingVersion", message: matched.noMatch } };
+
+ return { success: true, data: matched.release };
+};
+
+const codebergReleasesSchema = z.array(
+ z.object({
+ tag_name: z.string(),
+ published_at: z.string().transform((value) => new Date(value)),
+ url: z.string(),
+ body: z.string(),
+ prerelease: z.boolean(),
+ }),
+);
+
+const codebergDetailsSchema = z.object({
+ html_url: z.string(),
+ description: z.string(),
+ fork: z.boolean(),
+ archived: z.boolean(),
+ created_at: z.string().transform((value) => new Date(value)),
+ stars_count: z.number(),
+ open_issues_count: z.number(),
+ forks_count: z.number(),
+});
+
+const getCodebergReleaseAsync = async (
+ baseUrl: string,
+ identifier: string,
+ versionRegex?: string,
+ token?: string,
+): Promise => {
+ const parsed = parseOwnerName(identifier);
+ if (!parsed)
+ return {
+ success: false,
+ error: { code: "invalidIdentifier", message: `Cannot parse "${identifier}" as owner/repo` },
+ };
+
+ const headers: Record = {};
+ if (token) headers.Authorization = `token ${token}`;
+
+ const response = await fetchProvider(
+ buildUrl(baseUrl, `/api/v1/repos/${encodeURIComponent(parsed.owner)}/${encodeURIComponent(parsed.name)}/releases`),
+ headers.Authorization ? { headers } : undefined,
+ );
+ if (!response.ok)
+ return {
+ success: false,
+ error: { code: "unexpected", message: `Codeberg ${response.status}: ${response.statusText}` },
+ };
+
+ const result = codebergReleasesSchema.safeParse(await response.json());
+ if (!result.success) return { success: false, error: { code: "unexpected", message: result.error.message } };
+
+ const releases = result.data.map((tag) => ({
+ latestRelease: tag.tag_name,
+ latestReleaseAt: tag.published_at,
+ releaseUrl: tag.url,
+ releaseDescription: tag.body,
+ isPreRelease: tag.prerelease,
+ }));
+ const matched = getLatestRelease(releases, versionRegex);
+ if ("noMatch" in matched) return { success: false, error: { code: "noMatchingVersion", message: matched.noMatch } };
+
+ const details = await getCodebergDetailsAsync(baseUrl, parsed.owner, parsed.name, token);
+ return { success: true, data: { ...details, ...matched.release } };
+};
+
+const getCodebergDetailsAsync = async (
+ baseUrl: string,
+ owner: string,
+ name: string,
+ token?: string,
+): Promise => {
+ const headers: Record = {};
+ if (token) headers.Authorization = `token ${token}`;
+
+ const response = await fetchProvider(
+ buildUrl(baseUrl, `/api/v1/repos/${encodeURIComponent(owner)}/${encodeURIComponent(name)}`),
+ headers.Authorization ? { headers } : undefined,
+ );
+ if (!response.ok) return {};
+
+ const result = codebergDetailsSchema.safeParse(await response.json());
+ if (!result.success) return {};
+
+ return {
+ projectUrl: result.data.html_url,
+ projectDescription: result.data.description,
+ isFork: result.data.fork,
+ isArchived: result.data.archived,
+ createdAt: result.data.created_at,
+ starsCount: result.data.stars_count,
+ openIssues: result.data.open_issues_count,
+ forksCount: result.data.forks_count,
+ };
+};
+
+const linuxServerIOReleasesSchema = z.object({
+ data: z.object({
+ repositories: z.object({
+ linuxserver: z.array(
+ z.object({
+ name: z.string(),
+ initial_date: z
+ .string()
+ .transform((value) => new Date(value))
+ .optional(),
+ github_url: z.string(),
+ description: z.string(),
+ version: z.string(),
+ version_timestamp: z.string().transform((value) => new Date(value)),
+ stars: z.number(),
+ deprecated: z.boolean(),
+ changelog: z.array(z.object({ date: z.string(), desc: z.string() })).optional(),
+ }),
+ ),
+ }),
+ }),
+});
+
+const getLinuxServerIOReleaseAsync = async (
+ baseUrl: string,
+ identifier: string,
+ versionRegex?: string,
+): Promise => {
+ const parsed = parseOwnerName(identifier);
+ if (!parsed)
+ return {
+ success: false,
+ error: { code: "invalidIdentifier", message: `Cannot parse "${identifier}" as owner/name` },
+ };
+
+ const response = await fetchProvider(buildUrl(baseUrl, "/api/v1/images"));
+ if (!response.ok)
+ return {
+ success: false,
+ error: { code: "unexpected", message: `LSIO ${response.status}: ${response.statusText}` },
+ };
+
+ const result = linuxServerIOReleasesSchema.safeParse(await response.json());
+ if (!result.success) return { success: false, error: { code: "unexpected", message: result.error.message } };
+
+ const release = result.data.data.repositories.linuxserver.find((repo) => repo.name === parsed.name);
+ if (!release)
+ return {
+ success: false,
+ error: { code: "noReleasesFound", message: `Image "${parsed.name}" not found in LinuxServer.io registry` },
+ };
+
+ const regex = compileVersionRegex(versionRegex);
+ if (versionRegex && !regex) {
+ return {
+ success: false,
+ error: { code: "noMatchingVersion", message: `Invalid regex: /${versionRegex}/` },
+ };
+ }
+
+ if (regex && !regex.test(release.version)) {
+ return {
+ success: false,
+ error: {
+ code: "noMatchingVersion",
+ message: `Regex /${versionRegex}/ does not match LSIO version "${release.version}"`,
+ },
+ };
+ }
+
+ return {
+ success: true,
+ data: {
+ latestRelease: release.version,
+ latestReleaseAt: release.version_timestamp,
+ releaseDescription: release.changelog?.shift()?.desc,
+ projectUrl: release.github_url,
+ projectDescription: release.description,
+ isArchived: release.deprecated,
+ createdAt: release.initial_date,
+ starsCount: release.stars,
+ },
+ };
+};
+
+const quayReleasesSchema = z.object({
+ description: z.string().optional(),
+ tags: z.record(z.string(), z.object({ name: z.string(), last_modified: z.string() })),
+});
+
+const getQuayReleaseAsync = async (
+ baseUrl: string,
+ identifier: string,
+ versionRegex?: string,
+): Promise => {
+ const parsed = parseOwnerName(identifier);
+ if (!parsed)
+ return {
+ success: false,
+ error: { code: "invalidIdentifier", message: `Cannot parse "${identifier}" as owner/repo` },
+ };
+
+ const response = await fetchProvider(
+ buildUrl(
+ baseUrl,
+ `/api/v1/repository/${encodeURIComponent(parsed.owner)}/${encodeURIComponent(parsed.name)}?includeTags=true&includeStats=true`,
+ ),
+ );
+ if (!response.ok)
+ return {
+ success: false,
+ error: { code: "unexpected", message: `Quay ${response.status}: ${response.statusText}` },
+ };
+
+ const result = quayReleasesSchema.safeParse(await response.json());
+ if (!result.success) return { success: false, error: { code: "unexpected", message: result.error.message } };
+
+ const releases = Object.values(result.data.tags).reduce((acc, tag) => {
+ if (!tag.name || !tag.last_modified) return acc;
+ acc.push({
+ latestRelease: tag.name,
+ latestReleaseAt: new Date(tag.last_modified),
+ releaseUrl: `https://quay.io/repository/${encodeURIComponent(parsed.owner)}/${encodeURIComponent(parsed.name)}/tag/${encodeURIComponent(tag.name)}`,
+ });
+ return acc;
+ }, []);
+ const matched = getLatestRelease(releases, versionRegex);
+ if ("noMatch" in matched) return { success: false, error: { code: "noMatchingVersion", message: matched.noMatch } };
+
+ return { success: true, data: { projectDescription: result.data.description, ...matched.release } };
+};
diff --git a/packages/request-handler/src/releases.ts b/packages/request-handler/src/releases.ts
index 8b67e9793..e089bc661 100644
--- a/packages/request-handler/src/releases.ts
+++ b/packages/request-handler/src/releases.ts
@@ -1,16 +1,10 @@
-import type { IntegrationKindByCategory } from "@homarr/definitions";
-import type { ReleaseResponse, ReleasesRepository } from "@homarr/integrations";
-import { createIntegrationAsync } from "@homarr/integrations";
+import type { ReleaseResponse, ReleasesRepositoryRequest } from "./release-providers";
+import { getLatestMatchingReleaseAsync } from "./release-providers";
+import { createRequestHandler } from "./lib/request-handler";
-import { createIntegrationRequestHandler } from "./lib/integration-request-handler";
-
-export const releasesRequestHandler = createIntegrationRequestHandler<
- ReleaseResponse,
- IntegrationKindByCategory<"releasesProvider">,
- ReleasesRepository
->({
- requestAsync: async (integration, input) => {
- const instance = await createIntegrationAsync(integration);
- return instance.getLatestMatchingReleaseAsync(input.identifier, input.versionRegex);
+export const releasesRequestHandler = createRequestHandler({
+ async requestAsync(input) {
+ return await getLatestMatchingReleaseAsync(input);
},
+ cacheTtlMs: 5 * 60 * 1000,
});
diff --git a/packages/request-handler/src/test/release-providers.spec.ts b/packages/request-handler/src/test/release-providers.spec.ts
new file mode 100644
index 000000000..67ed3d71c
--- /dev/null
+++ b/packages/request-handler/src/test/release-providers.spec.ts
@@ -0,0 +1,192 @@
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import { Response } from "undici";
+
+import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
+
+import { getLatestMatchingReleaseAsync } from "../release-providers";
+
+vi.mock("@homarr/core/infrastructure/http", () => ({
+ fetchWithTrustedCertificatesAsync: vi.fn(),
+}));
+vi.mock("@homarr/core/infrastructure/logs", () => ({
+ createLogger: () => ({
+ warn: vi.fn(),
+ }),
+}));
+
+const mockedFetch = vi.mocked(fetchWithTrustedCertificatesAsync);
+
+describe("getLatestMatchingReleaseAsync for GitHub Container Registry", () => {
+ beforeEach(() => {
+ mockedFetch.mockReset();
+ });
+
+ test("normalizes full image refs and returns latest from anonymous OCI registry metadata", async () => {
+ mockGhcrResponses({
+ repositoryName: "homarr-labs/homarr",
+ tags: ["v1.0.0", "latest"],
+ createdAtByTag: {
+ latest: "2026-06-19T20:30:59.853Z",
+ },
+ });
+
+ const result = await getLatestMatchingReleaseAsync({
+ id: "homarr",
+ provider: "gitHubContainerRegistry",
+ identifier: "ghcr.io/homarr-labs/homarr:latest",
+ });
+
+ expect(result).toEqual({
+ success: true,
+ data: {
+ projectUrl: "https://github.com/homarr-labs/homarr",
+ latestRelease: "latest",
+ latestReleaseAt: new Date("2026-06-19T20:30:59.853Z"),
+ releaseUrl: "https://github.com/homarr-labs/homarr/pkgs/container/homarr",
+ },
+ });
+ expectUrl(0, "https://ghcr.io/token");
+ expect(new URL(mockedFetch.mock.calls[0]?.[0].toString() ?? "").searchParams.get("service")).toBe("ghcr.io");
+ expect(new URL(mockedFetch.mock.calls[0]?.[0].toString() ?? "").searchParams.get("scope")).toBe(
+ "repository:homarr-labs/homarr:pull",
+ );
+ });
+
+ test("uses custom registry base URL for GHCR-compatible registries", async () => {
+ mockGhcrResponses({
+ registryOrigin: "https://registry.example.com",
+ repositoryName: "homarr-labs/homarr",
+ tags: ["latest"],
+ createdAtByTag: {
+ latest: "2026-06-19T20:30:59.853Z",
+ },
+ });
+
+ await getLatestMatchingReleaseAsync({
+ id: "homarr",
+ provider: "gitHubContainerRegistry",
+ identifier: "homarr-labs/homarr",
+ providerUrl: "https://registry.example.com/",
+ });
+
+ expectUrl(0, "https://registry.example.com/token");
+ expect(new URL(mockedFetch.mock.calls[0]?.[0].toString() ?? "").searchParams.get("service")).toBe(
+ "registry.example.com",
+ );
+ expectUrl(1, "https://registry.example.com/v2/homarr-labs/homarr/tags/list");
+ });
+
+ test("chooses the newest matching version tag", async () => {
+ mockGhcrResponses({
+ repositoryName: "muchobien/pocketbase",
+ tags: ["0.22.0", "0.23.0", "latest"],
+ createdAtByTag: {
+ "0.22.0": "2026-01-01T00:00:00.000Z",
+ "0.23.0": "2026-02-01T00:00:00.000Z",
+ },
+ });
+
+ const result = await getLatestMatchingReleaseAsync({
+ id: "pocketbase",
+ provider: "gitHubContainerRegistry",
+ identifier: "ghcr.io/muchobien/pocketbase:latest",
+ versionRegex: "^0\\.[0-9]+\\.[0-9]+$",
+ });
+
+ expect(result.success).toBe(true);
+ if (!result.success) return;
+ expect(result.data.latestRelease).toBe("0.23.0");
+ expect(result.data.latestReleaseAt).toEqual(new Date("2026-02-01T00:00:00.000Z"));
+ });
+
+ test("returns invalidIdentifier for missing package name", async () => {
+ const result = await getLatestMatchingReleaseAsync({
+ id: "invalid",
+ provider: "gitHubContainerRegistry",
+ identifier: "ghcr.io/homarr-labs",
+ });
+
+ expect(result).toEqual({
+ success: false,
+ error: expect.objectContaining({ code: "invalidIdentifier" }),
+ });
+ expect(mockedFetch).not.toHaveBeenCalled();
+ });
+
+ test("returns unexpected with provider error message", async () => {
+ mockedFetch.mockResolvedValueOnce(createJsonResponse({ errors: [] }, { status: 500, statusText: "Registry down" }));
+
+ const result = await getLatestMatchingReleaseAsync({
+ id: "homarr",
+ provider: "gitHubContainerRegistry",
+ identifier: "homarr-labs/homarr",
+ });
+
+ expect(result).toEqual({ success: false, error: { code: "unexpected", message: "Registry down" } });
+ });
+});
+
+interface MockGhcrResponsesInput {
+ registryOrigin?: string;
+ repositoryName: string;
+ tags: string[];
+ createdAtByTag: Record;
+}
+
+const mockGhcrResponses = ({
+ registryOrigin = "https://ghcr.io",
+ repositoryName,
+ tags,
+ createdAtByTag,
+}: MockGhcrResponsesInput) => {
+ mockedFetch.mockImplementation(async (input) => {
+ const url = new URL(input.toString());
+ const path = url.pathname;
+
+ if (url.origin !== registryOrigin) {
+ return createJsonResponse({ error: "unexpected origin" }, { status: 404, statusText: "Not Found" });
+ }
+
+ if (path === "/token") return createJsonResponse({ token: "token" });
+ if (path === `/v2/${repositoryName}/tags/list`) return createJsonResponse({ name: repositoryName, tags });
+
+ const manifestMatch = new RegExp(`^/v2/${escapeRegExp(repositoryName)}/manifests/(.+)$`).exec(path);
+ if (manifestMatch) {
+ const reference = decodeURIComponent(manifestMatch[1] ?? "");
+ if (reference.startsWith("sha256:")) {
+ return createJsonResponse({ config: { digest: `sha256:config-${reference.slice("sha256:".length)}` } });
+ }
+ return createJsonResponse({
+ manifests: [{ digest: `sha256:${reference}` }],
+ });
+ }
+
+ const blobMatch = new RegExp(`^/v2/${escapeRegExp(repositoryName)}/blobs/sha256:config-(.+)$`).exec(path);
+ if (blobMatch) {
+ const tag = decodeURIComponent(blobMatch[1] ?? "");
+ return createJsonResponse({ created: createdAtByTag[tag] ?? "2026-01-01T00:00:00.000Z" });
+ }
+
+ return createJsonResponse({ error: "not found" }, { status: 404, statusText: "Not Found" });
+ });
+};
+
+interface JsonResponseInit {
+ status?: number;
+ statusText?: string;
+}
+
+const createJsonResponse = (body: unknown, init: JsonResponseInit = {}) =>
+ new Response(JSON.stringify(body), {
+ status: init.status ?? 200,
+ statusText: init.statusText,
+ headers: {
+ "content-type": "application/json",
+ },
+ });
+
+const expectUrl = (callIndex: number, expectedUrl: string) => {
+ expect(mockedFetch.mock.calls[callIndex]?.[0].toString().split("?")[0]).toBe(expectedUrl);
+};
+
+const escapeRegExp = (value: string) => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
diff --git a/packages/request-handler/src/timetable.ts b/packages/request-handler/src/timetable.ts
index 10050a89e..7669d6c9a 100644
--- a/packages/request-handler/src/timetable.ts
+++ b/packages/request-handler/src/timetable.ts
@@ -1,30 +1,148 @@
-import type { IntegrationKindByCategory } from "@homarr/definitions";
-import { createIntegrationAsync } from "@homarr/integrations";
-import type { Station, Timetable } from "@homarr/integrations/types";
+import { z } from "zod/v4";
-import { createIntegrationRequestHandler } from "./lib/integration-request-handler";
+import { ResponseError } from "@homarr/common/server";
+import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
-export const timetableSearchStationsRequestHandler = createIntegrationRequestHandler<
- Station[],
- IntegrationKindByCategory<"timetable">,
- { query: string }
->({
- async requestAsync(integration, input) {
- const integrationInstance = await createIntegrationAsync(integration);
- return await integrationInstance.searchStationsAsync(input.query);
+import { createRequestHandler } from "./lib/request-handler";
+
+export interface Station {
+ id: string;
+ name: string;
+}
+
+export interface TimetableEntry {
+ timestamp: Date;
+ delay: number;
+ line: {
+ name: string;
+ color: string | null;
+ } | null;
+ location: string;
+ platform: {
+ name: string;
+ hasChanged: boolean;
+ } | null;
+}
+
+export interface Timetable {
+ stationId: string;
+ timestamp: Date;
+ entries: TimetableEntry[];
+}
+
+const supportedStationTypes = ["bus", "tram", "train", "ship", "cablecar", "funicular", "chairlift"];
+
+export const timetableSearchStationsRequestHandler = createRequestHandler({
+ async requestAsync(input) {
+ return await searchStationsAsync(input.baseUrl, input.query);
},
+ cacheTtlMs: 24 * 60 * 60 * 1000,
});
-export const timetableGetTimetableRequestHandler = createIntegrationRequestHandler<
- Timetable,
- IntegrationKindByCategory<"timetable">,
- { stationId: string; limit: number }
->({
- async requestAsync(integration, input) {
- const integrationInstance = await createIntegrationAsync(integration);
- return await integrationInstance.getTimetableAsync({
- stationId: input.stationId,
- limit: input.limit,
- });
+export const timetableGetTimetableRequestHandler = createRequestHandler({
+ async requestAsync(input) {
+ return await getTimetableAsync(input.baseUrl, { stationId: input.stationId, limit: input.limit });
},
+ cacheTtlMs: 60_000,
});
+
+const buildUrl = (baseUrl: string, path: `/${string}`, queryParams: Record) => {
+ const url = new URL(`${baseUrl.replace(/\/$/, "")}${path}`);
+ for (const [key, value] of Object.entries(queryParams)) {
+ url.searchParams.set(key, value.toString());
+ }
+ return url;
+};
+
+const searchStationsAsync = async (baseUrl: string, query: string): Promise => {
+ const response = await fetchWithTrustedCertificatesAsync(
+ buildUrl(baseUrl, "/timetable/api/completion.json", { term: query, show_ids: 1, nofavorites: 1 }),
+ );
+ if (!response.ok) throw new ResponseError(response);
+
+ const data = await searchSchema.parseAsync(await response.json());
+ return data
+ .filter((item) => supportedStationTypes.some((type) => item.iconclass.endsWith(type)))
+ .map((item) => (item.id !== undefined ? { id: item.id, name: item.label } : null))
+ .filter((item) => item !== null);
+};
+
+const getTimetableAsync = async (
+ baseUrl: string,
+ options: { stationId: string; limit: number },
+): Promise => {
+ const now = new Date();
+ const date = new Intl.DateTimeFormat("en-US", {
+ timeZone: "Europe/Zurich",
+ month: "2-digit",
+ day: "2-digit",
+ year: "numeric",
+ }).format(now);
+ const time = new Intl.DateTimeFormat("en-GB", {
+ timeZone: "Europe/Zurich",
+ hour: "2-digit",
+ minute: "2-digit",
+ hour12: false,
+ }).format(now);
+ const response = await fetchWithTrustedCertificatesAsync(
+ buildUrl(baseUrl, "/timetable/api/stationboard.json", {
+ stop: options.stationId,
+ limit: options.limit,
+ show_delays: 1,
+ show_tracks: 1,
+ date,
+ time,
+ }),
+ );
+ if (!response.ok) throw new ResponseError(response);
+
+ const data = await timetableSchema.parseAsync(await response.json());
+ return {
+ stationId: options.stationId,
+ timestamp: now,
+ entries: data.connections.map((connection) => {
+ const color = connection.color.split("~")[0];
+ return {
+ timestamp: connection.time,
+ line: connection.line
+ ? {
+ name: connection.line,
+ color: color && color.length >= 1 ? `#${color}` : null,
+ }
+ : null,
+ location: connection.terminal.name,
+ delay: connection.dep_delay,
+ platform: connection.track
+ ? {
+ name: connection.track.replace("!", ""),
+ hasChanged: connection.track.includes("!"),
+ }
+ : null,
+ };
+ }),
+ };
+};
+
+const timetableSchema = z.object({
+ connections: z.array(
+ z.object({
+ time: z.string().transform((str) => new Date(str)),
+ line: z.string().optional(),
+ color: z.string(),
+ terminal: z.object({ name: z.string() }),
+ track: z.string().optional(),
+ dep_delay: z
+ .string()
+ .optional()
+ .transform((str) => (str ? parseInt(str) : 0)),
+ }),
+ ),
+});
+
+const searchSchema = z.array(
+ z.object({
+ id: z.string().optional(),
+ label: z.string(),
+ iconclass: z.string(),
+ }),
+);
diff --git a/packages/translation/src/lang/en.json b/packages/translation/src/lang/en.json
index b27decaac..f4cbf6f98 100644
--- a/packages/translation/src/lang/en.json
+++ b/packages/translation/src/lang/en.json
@@ -1903,6 +1903,9 @@
"title": "Departures {station}",
"noStation": "No station selected",
"option": {
+ "baseUrl": {
+ "label": "Search.ch URL"
+ },
"station": {
"label": "Station"
}
@@ -2776,8 +2779,8 @@
"name": "Immich Album",
"option": {
"albumId": {
- "label": "Album ID",
- "description": "This is a unique ID which refers to your Immich album. You can find this id by opening an album and copying the unique string from the URL, for example 'a21aca09-9f05-47dc-b1a1-7b53c547226e'"
+ "label": "Album",
+ "description": "Select the Immich album to show in the slideshow."
},
"rotationIntervalSeconds": {
"label": "Interval in seconds",
@@ -2786,6 +2789,10 @@
"showPhotoInfo": {
"label": "Show photo info",
"description": "Display date of the picture and the current index at the bottom of the slideshow"
+ },
+ "randomizePhotos": {
+ "label": "Randomize photos",
+ "description": "Show photos in a random order instead of always starting with the same album order."
}
},
"description": "Slideshow of pictures in your Immich album",
@@ -3150,6 +3157,9 @@
"provider": {
"label": "Provider"
},
+ "providerUrl": {
+ "label": "Provider URL"
+ },
"identifier": {
"label": "Identifier",
"placeholder": "Name or Owner/Name"
@@ -3197,6 +3207,13 @@
"noProvider": {
"label": "No Provider",
"tooltip": "The provider could not be parsed, please manually set it after importing the images"
+ },
+ "tokens": {
+ "label": "Provider Tokens",
+ "token": "Token",
+ "configured": "Token configured",
+ "notConfigured": "No token set",
+ "save": "Save"
}
}
},
@@ -3219,8 +3236,9 @@
"invalidIdentifier": "Invalid identifier",
"noMatchingVersion": "No matching version found",
"noReleasesFound": "No releases found",
- "noProviderSeleceted": "No provider selected",
- "noProviderResponse": "No response from provider"
+ "noProviderSelected": "No provider selected",
+ "noProviderResponse": "No response from provider",
+ "unexpected": "Unexpected provider error"
}
}
},
diff --git a/packages/widgets/src/_inputs/common.tsx b/packages/widgets/src/_inputs/common.tsx
index 5c7769eb1..c7be65262 100644
--- a/packages/widgets/src/_inputs/common.tsx
+++ b/packages/widgets/src/_inputs/common.tsx
@@ -8,6 +8,7 @@ export interface CommonWidgetInputProps {
property: string;
options: Omit, "defaultValue" | "type">;
initialOptions: Record;
+ itemId?: string;
}
type UseWidgetInputTranslationReturnType = (key: "label" | "description") => string;
diff --git a/packages/widgets/src/_inputs/widget-dynamic-select-input.tsx b/packages/widgets/src/_inputs/widget-dynamic-select-input.tsx
index de8ef5021..3b5b636aa 100644
--- a/packages/widgets/src/_inputs/widget-dynamic-select-input.tsx
+++ b/packages/widgets/src/_inputs/widget-dynamic-select-input.tsx
@@ -24,7 +24,11 @@ export const WidgetDynamicSelectInput = ({ property, kind, options }: CommonWidg
const inputProps = form.getInputProps(`options.${property}`);
const [search, setSearch] = useState("");
const [debouncedSearch] = useDebouncedValue(search, 300);
- const { isPending, options: selectOptions } = options.useOptions(debouncedSearch, form.values.integrationIds);
+ const { isPending, options: selectOptions } = options.useOptions(
+ debouncedSearch,
+ form.values.integrationIds,
+ form.values.options,
+ );
const currentOption = inputProps.value as DynamicSelectOption | null;
const onChange = inputProps.onChange as (value: DynamicSelectOption | null) => void;
diff --git a/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx b/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx
index adc579ac4..675d56330 100644
--- a/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx
+++ b/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx
@@ -12,6 +12,7 @@ import {
Group,
Image,
Loader,
+ PasswordInput,
Select,
Stack,
Text,
@@ -27,6 +28,7 @@ import {
IconCopy,
IconCopyCheckFilled,
IconEdit,
+ IconKey,
IconPackageImport,
IconPlus,
IconTrash,
@@ -38,16 +40,20 @@ import { escapeForRegEx } from "@tiptap/react";
import { clientApi } from "@homarr/api/client";
import { useSession } from "@homarr/auth/client";
import { createId } from "@homarr/common";
-import { getIconUrl } from "@homarr/definitions";
-import type { IntegrationKind } from "@homarr/definitions";
+import type { ReleaseProviderKind } from "@homarr/definitions";
+import {
+ getReleaseProviderDefaultUrl,
+ getReleaseProviderIconUrl,
+ getReleaseProviderName,
+ normalizeReleaseProviderIdentifier,
+ releaseProviderKinds,
+} from "@homarr/definitions";
import { findBestIconMatch, IconPicker } from "@homarr/forms-collection";
import { createModal, useModalAction } from "@homarr/modals";
import { useScopedI18n } from "@homarr/translation/client";
import { MaskedImage } from "@homarr/ui";
import type { ReleasesRepository, ReleasesVersionFilter } from "../releases/releases-repository";
-import { WidgetIntegrationSelect } from "../widget-integration-select";
-import type { IntegrationSelectOption } from "../widget-integration-select";
import type { CommonWidgetInputProps } from "./common";
import { useWidgetInputTranslation } from "./common";
import { useFormContext } from "./form";
@@ -57,13 +63,10 @@ interface FormValidation {
errors: FormErrors;
}
-interface Integration extends IntegrationSelectOption {
- iconUrl: string;
-}
-
export const WidgetMultiReleasesRepositoriesInput = ({
property,
kind,
+ itemId,
}: CommonWidgetInputProps<"multiReleasesRepositories">) => {
const t = useWidgetInputTranslation(kind, property);
const tRepository = useScopedI18n("widget.releases.option.repositories");
@@ -78,36 +81,19 @@ export const WidgetMultiReleasesRepositoriesInput = ({
const { data: session } = useSession();
const isAdmin = session?.user.permissions.includes("admin") ?? false;
- const integrationsApi = clientApi.integration.allOfGivenCategory.useQuery(
- {
- category: "releasesProvider",
- },
- {
- refetchOnMount: false,
- },
- );
- const integrations = useMemo(
- () =>
- integrationsApi.data?.reduce>((acc, integration) => {
- acc[integration.id] = {
- id: integration.id,
- name: integration.name,
- url: integration.url,
- kind: integration.kind,
- iconUrl: getIconUrl(integration.kind),
- };
- return acc;
- }, {}) ?? {},
- [integrationsApi],
+ const providerOptions = useMemo(
+ () => releaseProviderKinds.map((provider) => ({ value: provider, label: getReleaseProviderName(provider) })),
+ [],
);
const onRepositorySave = useCallback(
(repository: ReleasesRepository, index: number): FormValidation => {
- form.setFieldValue(`options.${property}.${index}.providerIntegrationId`, repository.providerIntegrationId);
+ form.setFieldValue(`options.${property}.${index}.provider`, repository.provider);
form.setFieldValue(`options.${property}.${index}.identifier`, repository.identifier);
form.setFieldValue(`options.${property}.${index}.name`, repository.name);
form.setFieldValue(`options.${property}.${index}.versionFilter`, repository.versionFilter);
form.setFieldValue(`options.${property}.${index}.iconUrl`, repository.iconUrl);
+ form.setFieldValue(`options.${property}.${index}.providerUrl`, repository.providerUrl);
const formValidation = form.validate();
const fieldErrors: FormErrors = Object.entries(formValidation.errors).reduce((acc, [key, value]) => {
@@ -150,7 +136,7 @@ export const WidgetMultiReleasesRepositoriesInput = ({
onRepositorySave: (saved) => onRepositorySave(saved, index),
onRepositoryCancel: () => onRepositoryRemove(index),
versionFilterPrecisionOptions,
- integrations,
+ providerOptions,
});
};
@@ -181,7 +167,6 @@ export const WidgetMultiReleasesRepositoriesInput = ({
onClick={() =>
openImportModal({
repositories,
- integrations,
versionFilterPrecisionOptions,
onConfirm: (selectedRepositories) => {
if (!selectedRepositories.length) return;
@@ -208,22 +193,22 @@ export const WidgetMultiReleasesRepositoriesInput = ({
- {integration?.name ?? ""}
+
+ {providerName}
@@ -240,7 +225,7 @@ export const WidgetMultiReleasesRepositoriesInput = ({
repository,
onRepositorySave: (saved) => onRepositorySave(saved, index),
versionFilterPrecisionOptions,
- integrations,
+ providerOptions,
})
}
variant="light"
@@ -267,10 +252,125 @@ export const WidgetMultiReleasesRepositoriesInput = ({
);
})}
+ {itemId &&
+ {authProviders.map((provider) => (
+ {
+ await setSecret.mutateAsync({ itemId, kind: provider, value });
+ }}
+ onDelete={async () => {
+ await deleteSecret.mutateAsync({ itemId, kind: provider });
+ }}
+ />
+ ))}
+
+
+ );
+};
+
+const ProviderTokenInput = ({
+ provider,
+ hasToken,
+ onSave,
+ onDelete,
+}: {
+ provider: ReleaseProviderKind;
+ hasToken: boolean;
+ onSave: (value: string) => Promise;
+ onDelete: () => Promise;
+}) => {
+ const tRepository = useScopedI18n("widget.releases.option.repositories");
+ const [value, setValue] = useState("");
+ const [editing, setEditing] = useState(false);
+ const [saving, setSaving] = useState(false);
+
+ const handleSave = async () => {
+ if (!value.trim()) return;
+ setSaving(true);
+ try {
+ await onSave(value.trim());
+ setValue("");
+ setEditing(false);
+ } finally {
+ setSaving(false);
+ }
+ };
+
+ const handleDelete = async () => {
+ setSaving(true);
+ try {
+ await onDelete();
+ setValue("");
+ setEditing(false);
+ } finally {
+ setSaving(false);
+ }
+ };
+
+ return (
+
+ {
+ setValue(e.currentTarget.value);
+ setEditing(true);
+ }}
+ style={{ flex: 1 }}
+ size="xs"
+ leftSection={
+ {tRepository("tokens.save")}
+
+ )}
+ {hasToken && !editing && (
+
+
+ )}
+
+ );
+};
+
const formatVersionFilterRegex = (versionFilter: ReleasesVersionFilter | undefined) => {
if (!versionFilter) return undefined;
@@ -292,7 +392,7 @@ interface RepositoryEditProps {
onRepositorySave: (repository: ReleasesRepository) => FormValidation;
onRepositoryCancel?: () => void;
versionFilterPrecisionOptions: string[];
- integrations: Record;
+ providerOptions: { value: ReleaseProviderKind; label: string }[];
}
const RepositoryEditModal = createModal(({ innerProps, actions }) => {
@@ -300,11 +400,6 @@ const RepositoryEditModal = createModal(({ innerProps, acti
const [loading, setLoading] = useState(false);
const [tempRepository, setTempRepository] = useState(() => ({ ...innerProps.repository }));
const [formErrors, setFormErrors] = useState({});
- const integrationSelectOptions: IntegrationSelectOption[] = useMemo(
- () => Object.values(innerProps.integrations),
- [innerProps.integrations],
- );
-
// Allows user to not select an icon by removing the url from the input,
// will only try and get an icon if the name or identifier changes
const [autoSetIcon, setAutoSetIcon] = useState(false);
@@ -359,15 +454,14 @@ const RepositoryEditModal = createModal(({ innerProps, acti
- {
- handleChange({ providerIntegrationId: value.length > 0 ? value.pop() : undefined });
+ handleChange({ provider: value ? (value as ReleaseProviderKind) : undefined });
}}
/>
@@ -395,6 +489,16 @@ const RepositoryEditModal = createModal(({ innerProps, acti
/>
+ {
+ handleChange({ providerUrl: event.currentTarget.value || undefined });
+ }}
+ error={formErrors[`${innerProps.fieldPath}.providerUrl`]}
+ />
+
void;
@@ -520,12 +623,12 @@ interface ImportRepositorySelectProps {
const ImportRepositorySelect = ({
repository,
checked,
- integration,
versionFilterPrecisionOptions,
disabled = false,
onImageSelectionChanged = undefined,
}: ImportRepositorySelectProps) => {
const tRepository = useScopedI18n("widget.releases.option.repositories");
+ const provider = repository.provider;
return (
@@ -568,12 +671,12 @@ const ImportRepositorySelect = ({
)}
-
+
- {integration ? (
+ {provider ? (
- {integration?.name ?? tRepository("noProvider.label")}
+ {provider ? getReleaseProviderName(provider) : tRepository("noProvider.label")}
@@ -594,7 +697,6 @@ const ImportRepositorySelect = ({
interface RepositoryImportProps {
repositories: ReleasesRepository[];
- integrations: Record;
versionFilterPrecisionOptions: string[];
onConfirm: (selectedRepositories: ReleasesRepositoryImport[]) => void;
isAdmin: boolean;
@@ -621,28 +723,25 @@ const RepositoryImportModal = createModal(({ innerProps,
if (!identifier) return acc;
- const providerKind = containerImageToProviderKind[source] ?? "dockerHub";
- const integrationId = Object.values(innerProps.integrations).find(
- (integration) => integration.kind === providerKind,
- )?.id;
+ const provider = containerImageToProviderKind[source] ?? "dockerHub";
+ const normalizedIdentifier = normalizeReleaseProviderIdentifier(provider, identifier);
- if (acc.some((item) => item.providerIntegrationId === integrationId && item.identifier === identifier))
- return acc;
+ if (acc.some((item) => item.provider === provider && item.identifier === normalizedIdentifier)) return acc;
acc.push({
id: createId(),
- providerIntegrationId: integrationId,
- identifier,
+ provider,
+ identifier: normalizedIdentifier,
iconUrl: container.iconUrl ?? undefined,
- name: formatIdentifierName(identifier),
+ name: formatIdentifierName(normalizedIdentifier),
versionFilter: version ? parseImageVersionToVersionFilter(version) : undefined,
alreadyImported: innerProps.repositories.some(
- (item) => item.providerIntegrationId === integrationId && item.identifier === identifier,
+ (item) => item.provider === provider && item.identifier === normalizedIdentifier,
),
});
return acc;
}, []) ?? [],
- [docker.data, innerProps.repositories, innerProps.integrations],
+ [docker.data, innerProps.repositories],
);
const handleConfirm = useCallback(() => {
@@ -718,27 +817,20 @@ const RepositoryImportModal = createModal(({ innerProps,
{importRepositories
.filter((repository) => !repository.alreadyImported)
- .map((repository) => {
- const integration = repository.providerIntegrationId
- ? innerProps.integrations[repository.providerIntegrationId]
- : undefined;
-
- return (
-
- isSelected
- ? setSelectedImages([...selectedImages, repository])
- : setSelectedImages(selectedImages.filter((img) => img !== repository))
- }
- />
- );
- })}
+ .map((repository) => (
+
+ isSelected
+ ? setSelectedImages([...selectedImages, repository])
+ : setSelectedImages(selectedImages.filter((img) => img !== repository))
+ }
+ />
+ ))}
)}
@@ -752,22 +844,15 @@ const RepositoryImportModal = createModal(({ innerProps,
{importRepositories
.filter((repository) => repository.alreadyImported)
- .map((repository) => {
- const integration = repository.providerIntegrationId
- ? innerProps.integrations[repository.providerIntegrationId]
- : undefined;
-
- return (
-
)}
@@ -794,8 +879,8 @@ const RepositoryImportModal = createModal(({ innerProps,
size: "xl",
});
-const containerImageToProviderKind: Record = {
- "ghcr.io": "github",
+const containerImageToProviderKind: Record = {
+ "ghcr.io": "gitHubContainerRegistry",
"docker.io": "dockerHub",
"lscr.io": "linuxServerIO",
"quay.io": "quay",
diff --git a/packages/widgets/src/immich/album-carousel/component.tsx b/packages/widgets/src/immich/album-carousel/component.tsx
index 9c157bfaa..84cdd83a9 100644
--- a/packages/widgets/src/immich/album-carousel/component.tsx
+++ b/packages/widgets/src/immich/album-carousel/component.tsx
@@ -1,7 +1,7 @@
"use client";
import type { Dispatch, SetStateAction } from "react";
-import { useEffect, useState } from "react";
+import { useEffect, useMemo, useState } from "react";
import { Box, Center, Group, Image, Stack, Text } from "@mantine/core";
import { IconAlertCircle, IconCalendar } from "@tabler/icons-react";
@@ -26,6 +26,15 @@ export default function ImmichAlbumCarouselWidget({
{ enabled: Boolean(options.albumId) },
);
+ const photoAssets = useMemo(() => {
+ const assets = album?.assets.filter((asset) => asset.type === "IMAGE") ?? [];
+ return options.randomizePhotos ? shuffle(assets) : assets;
+ }, [album?.assets, options.randomizePhotos]);
+
+ useEffect(() => {
+ setCurrentPhotoIndex(0);
+ }, [photoAssets]);
+
if (!options.albumId) {
return (items: T[]) {
+ const shuffled = [...items];
+ for (let index = shuffled.length - 1; index > 0; index--) {
+ const randomIndex = Math.floor(Math.random() * (index + 1));
+ const current = shuffled[index];
+ const random = shuffled[randomIndex];
+ if (current === undefined || random === undefined) continue;
+ shuffled[index] = random;
+ shuffled[randomIndex] = current;
+ }
+ return shuffled;
+}
+
interface CarouselProps {
assets: {
id: string;
diff --git a/packages/widgets/src/immich/album-carousel/index.ts b/packages/widgets/src/immich/album-carousel/index.ts
index 6ad37c50a..9f8110ffc 100644
--- a/packages/widgets/src/immich/album-carousel/index.ts
+++ b/packages/widgets/src/immich/album-carousel/index.ts
@@ -1,6 +1,8 @@
import { IconPhoto } from "@tabler/icons-react";
import z from "zod";
+import { clientApi } from "@homarr/api/client";
+
import { createWidgetDefinition } from "../../definition";
import { optionsBuilder } from "../../options";
@@ -10,9 +12,20 @@ export const { definition, componentLoader } = createWidgetDefinition("immich-al
integrationsRequired: true,
createOptions() {
return optionsBuilder.from((factory) => ({
- albumId: factory.text({
- defaultValue: "",
+ albumId: factory.integrationSelect({
withDescription: true,
+ clearable: true,
+ useOptions: (integrationIds: string[]) => {
+ const {
+ data = [],
+ isPending,
+ isError,
+ } = clientApi.widget.immich.getAlbums.useQuery(
+ { integrationId: integrationIds[0] ?? "" },
+ { enabled: integrationIds.length > 0, staleTime: 15 * 60 * 1000 },
+ );
+ return { data: data.map((album) => ({ value: album.id, label: album.albumName })), isPending, isError };
+ },
}),
rotationIntervalSeconds: factory.number({
defaultValue: 5,
@@ -23,6 +36,10 @@ export const { definition, componentLoader } = createWidgetDefinition("immich-al
defaultValue: false,
withDescription: true,
}),
+ randomizePhotos: factory.switch({
+ defaultValue: false,
+ withDescription: true,
+ }),
}));
},
}).withDynamicImport(() => import("./component"));
diff --git a/packages/widgets/src/modals/widget-edit-modal.tsx b/packages/widgets/src/modals/widget-edit-modal.tsx
index be0d3a178..d1713298c 100644
--- a/packages/widgets/src/modals/widget-edit-modal.tsx
+++ b/packages/widgets/src/modals/widget-edit-modal.tsx
@@ -38,6 +38,7 @@ interface ModalProps {
integrationData: IntegrationSelectOption[];
integrationSupport: boolean;
settings: SettingsContextProps;
+ itemId?: string;
appId?: string;
}
@@ -146,6 +147,7 @@ export const WidgetEditModal = createModal>(({ actions, i
property={key}
options={value as never}
initialOptions={innerProps.value.options}
+ itemId={innerProps.itemId}
/>
);
})}
diff --git a/packages/widgets/src/options.ts b/packages/widgets/src/options.ts
index 579d7eaaf..bf82ef226 100644
--- a/packages/widgets/src/options.ts
+++ b/packages/widgets/src/options.ts
@@ -55,6 +55,7 @@ interface DynamicSelectInput extends CommonInput {
useOptions: (
query: string,
integrationIds: string[],
+ options: Record,
) => {
isPending: boolean;
options: DynamicSelectOption[];
diff --git a/packages/widgets/src/releases/component.tsx b/packages/widgets/src/releases/component.tsx
index d244f315c..f0e32df7d 100644
--- a/packages/widgets/src/releases/component.tsx
+++ b/packages/widgets/src/releases/component.tsx
@@ -20,8 +20,9 @@ import ReactMarkdown from "react-markdown";
import { clientApi } from "@homarr/api/client";
import { useRequiredBoard } from "@homarr/boards/context";
-import { isDateWithin, isNullOrWhitespace, splitToChunksWithNItems } from "@homarr/common";
-import { getIconUrl } from "@homarr/definitions";
+import { createId, isDateWithin, isNullOrWhitespace, splitToChunksWithNItems } from "@homarr/common";
+import type { ReleaseProviderKind } from "@homarr/definitions";
+import { getReleaseProviderIconUrl, getReleaseProviderName } from "@homarr/definitions";
import { useScopedI18n } from "@homarr/translation/client";
import { MaskedOrNormalImage } from "@homarr/ui";
@@ -35,7 +36,7 @@ const formatRelativeDate = (value: string): string => {
return isMonths ? value.toUpperCase() : isOtherUnits ? value.toLowerCase() : value;
};
-export default function ReleasesWidget({ options }: WidgetComponentProps<"releases">) {
+export default function ReleasesWidget({ options, itemId }: WidgetComponentProps<"releases">) {
const t = useScopedI18n("widget.releases");
const now = useNow();
const formatter = useFormatter();
@@ -55,11 +56,16 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas
[options.newReleaseWithin, options.staleReleaseWithin],
);
- // Group repositories by integration
+ const normalizedRepositories = useMemo(
+ () => options.repositories.map((repo) => (repo.id ? repo : { ...repo, id: createId() })),
+ [options.repositories],
+ );
+
+ // Group repositories by provider
const groupedRepositories = useMemo(() => {
- return options.repositories.reduce(
+ return normalizedRepositories.reduce(
(acc, repo) => {
- const key = repo.providerIntegrationId;
+ const key = repo.provider;
if (!key) return acc;
acc[key] ??= [];
@@ -67,28 +73,30 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas
return acc;
},
- {} as Record,
+ {} as Partial>,
);
- }, [options.repositories]);
+ }, [normalizedRepositories]);
// For each group, split into chunks of 5
const batchedRepositories = useMemo(() => {
- return Object.entries(groupedRepositories).flatMap(([integrationId, group]) =>
+ return Object.entries(groupedRepositories).flatMap(([provider, group]) =>
splitToChunksWithNItems(group, 5).map((chunk) => ({
- integrationId,
+ provider: provider as ReleaseProviderKind,
repositories: chunk,
})),
);
}, [groupedRepositories]);
- const queryResults = clientApi.useQueries((t) =>
- batchedRepositories.flatMap(({ integrationId, repositories }) =>
- t.widget.releases.getLatest({
- integrationId,
+ const queryResults = clientApi.useQueries((trpc) =>
+ batchedRepositories.flatMap(({ provider, repositories }) =>
+ trpc.widget.releases.getLatest({
+ itemId,
repositories: repositories.map((repository) => ({
id: repository.id,
+ provider,
identifier: repository.identifier,
versionFilter: repository.versionFilter,
+ providerUrl: repository.providerUrl,
})),
}),
),
@@ -100,15 +108,15 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas
);
const repositories = useMemo(() => {
- const formattedResults = options.repositories
+ const formattedResults = normalizedRepositories
.map((repository) => {
- if (!repository.providerIntegrationId) return { ...repository, error: { code: "noProviderSeleceted" } };
+ if (!repository.provider) return { ...repository, error: { code: "noProviderSelected" } };
const repositoryResult = results.flat().find(({ id }) => id === repository.id);
if (!repositoryResult) return { ...repository, error: { code: "noProviderResponse" } };
if (!repositoryResult.success) return { ...repository, error: repositoryResult.error };
- const { data: release, integration } = repositoryResult;
+ const { data: release, provider } = repositoryResult;
const isReleaseWithin = (relativeDate: string) =>
Boolean(relativeDate) && isDateWithin(release.latestReleaseAt, relativeDate);
@@ -116,7 +124,7 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas
return {
...repository,
...release,
- integration: { name: integration.name, iconUrl: getIconUrl(integration.kind) },
+ providerMetadata: { name: getReleaseProviderName(provider), iconUrl: getReleaseProviderIconUrl(provider) },
isNewRelease: isReleaseWithin(relativeDateOptions.newReleaseWithin),
isStaleRelease: !isReleaseWithin(relativeDateOptions.staleReleaseWithin),
viewed: releasesViewedList[repository.id] === release.latestRelease,
@@ -139,7 +147,7 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas
return formattedResults;
}, [
results,
- options.repositories,
+ normalizedRepositories,
options.showOnlyHighlighted,
options.topReleases,
relativeDateOptions.newReleaseWithin,
@@ -173,7 +181,7 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas
className={combineClasses(
"releases-repository",
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
- `releases-repository-${repository.integration?.name ?? "error"}-${repository.name || repository.identifier.replace(/[^a-zA-Z0-9]/g, "_")}`,
+ `releases-repository-${repository.providerMetadata?.name ?? "error"}-${repository.name || repository.identifier.replace(/[^a-zA-Z0-9]/g, "_")}`,
classes.releasesRepository,
)}
gap={0}
@@ -187,7 +195,7 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas
>
-
+
{repository.identifier}
- {repository.integration && (
+ {repository.providerMetadata && (
- {repository.integration.name}
+
+ {repository.providerMetadata.name}
)}
@@ -614,7 +617,7 @@ const ExpandedDisplay = ({
{repository.error && (
<>
+ <Title className="releases-repository-expanded-error-title" order={4} ta="center" c="red">
{t("error.label")}
- {repository.error.code ? t(`error.messages.${repository.error.code}` as never) : repository.error.message}
+ {repository.error.message ??
+ (repository.error.code ? t(`error.messages.${repository.error.code}` as never) : null)}
)}
diff --git a/packages/widgets/src/releases/index.ts b/packages/widgets/src/releases/index.ts
index 8de5227ad..2c3d1d3a2 100644
--- a/packages/widgets/src/releases/index.ts
+++ b/packages/widgets/src/releases/index.ts
@@ -1,6 +1,9 @@
import { IconRocket } from "@tabler/icons-react";
import { z } from "zod/v4";
+import { createId } from "@homarr/common";
+import { releaseProviderKinds } from "@homarr/definitions";
+
import { createWidgetDefinition } from "../definition";
import { optionsBuilder } from "../options";
@@ -39,10 +42,20 @@ export const { definition, componentLoader } = createWidgetDefinition("releases"
validate: z.number().min(0),
}),
repositories: factory.multiReleasesRepositories({
- defaultValue: [],
+ defaultValue: [
+ {
+ id: createId(),
+ provider: "github" as const,
+ identifier: "homarr-labs/homarr",
+ name: "Homarr",
+ iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/homarr.png",
+ versionFilter: { prefix: "v", precision: 3 },
+ },
+ ],
validate: z.array(
z.object({
- providerIntegrationId: z.string().optional(),
+ id: z.string().default(() => createId()),
+ provider: z.enum(releaseProviderKinds).optional(),
identifier: z.string().min(1),
name: z.string().optional(),
versionFilter: z
@@ -53,6 +66,7 @@ export const { definition, componentLoader } = createWidgetDefinition("releases"
})
.optional(),
iconUrl: z.string().optional(),
+ providerUrl: z.string().url().optional(),
}),
),
}),
diff --git a/packages/widgets/src/releases/releases-repository.ts b/packages/widgets/src/releases/releases-repository.ts
index 157d9a146..3da40932a 100644
--- a/packages/widgets/src/releases/releases-repository.ts
+++ b/packages/widgets/src/releases/releases-repository.ts
@@ -1,3 +1,5 @@
+import type { ReleaseProviderKind } from "@homarr/definitions";
+
export interface ReleasesVersionFilter {
prefix?: string;
precision: number;
@@ -6,11 +8,12 @@ export interface ReleasesVersionFilter {
export interface ReleasesRepository {
id: string;
- providerIntegrationId?: string;
+ provider?: ReleaseProviderKind;
identifier: string;
name?: string;
versionFilter?: ReleasesVersionFilter;
iconUrl?: string;
+ providerUrl?: string;
}
export interface ReleasesRepositoryResponse extends ReleasesRepository {
@@ -32,7 +35,7 @@ export interface ReleasesRepositoryResponse extends ReleasesRepository {
forksCount?: number;
openIssues?: number;
- integration?: {
+ providerMetadata?: {
name: string;
iconUrl?: string;
};
diff --git a/packages/widgets/src/timetable/component.tsx b/packages/widgets/src/timetable/component.tsx
index 2f1ad982b..47751a751 100644
--- a/packages/widgets/src/timetable/component.tsx
+++ b/packages/widgets/src/timetable/component.tsx
@@ -7,27 +7,24 @@ import { useScopedI18n } from "@homarr/translation/client";
import type { DynamicSelectOption } from "../_inputs/widget-dynamic-select-input";
import type { WidgetComponentProps } from "../definition";
-export default function TimetableWidget({ options, integrationIds }: WidgetComponentProps<"timetable">) {
- // It will always have at least one integration as otherwise the NoIntegrationSelectedError would be thrown in item-content.tsx
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const integrationId = integrationIds[0]!;
+export default function TimetableWidget({ options }: WidgetComponentProps<"timetable">) {
const t = useScopedI18n("widget.timetable");
if (!options.station) {
return {t("noStation")} ;
}
- return 
- 
+ 
- 
- 
- 
- 
+ 
- 
- 
- 
- 
