A modern and easy to use dashboard. 80+ integrations. 20K+ icons built in. Authentication out of the box. No YAML, drag and drop configuration.
fix(coolify): use linked app URL for widget links (#7261)
Glaref527aa6feafe
diff --git a/apps/docs/docs/integrations/coolify/index.mdx b/apps/docs/docs/integrations/coolify/index.mdxindex 77e2cd822..ee468f191 100644--- a/apps/docs/docs/integrations/coolify/index.mdx+++ b/apps/docs/docs/integrations/coolify/index.mdx@@ -25,6 +25,8 @@ import { coolifyWidget } from "../../widgets/coolify";Use the root URL of your Coolify instance, for example `https://coolify.example.com`. Homarr calls Coolify endpoints under `/api` and `/api/v1` automatically.+If Homarr reaches Coolify over an internal address, link an app with the public address of your instance. Links in the widget then use the URL of the linked app.+</Alert>### Secretsdiff --git a/packages/api/src/router/widgets/__tests__/coolify.spec.ts b/packages/api/src/router/widgets/__tests__/coolify.spec.tsnew file mode 100644index 000000000..a4b97b034--- /dev/null+++ b/packages/api/src/router/widgets/__tests__/coolify.spec.ts@@ -0,0 +1,30 @@+import { describe, expect, test } from "vitest";++import { getExternalUrl } from "../coolify";++const createIntegration = (input: { externalUrl?: string | null }) => ({+ externalUrl: input.externalUrl ?? null,+});++describe("getExternalUrl", () => {+ test("returns the URL of the linked app", () => {+ expect(getExternalUrl(createIntegration({ externalUrl: "https://coolify.example.com" }))).toBe(+ "https://coolify.example.com",+ );+ });++ test("removes the trailing slash", () => {+ expect(getExternalUrl(createIntegration({ externalUrl: "https://coolify.example.com/" }))).toBe(+ "https://coolify.example.com",+ );+ });++ test("rejects credential bearing and non http URLs", () => {+ expect(getExternalUrl(createIntegration({ externalUrl: "https://user:[email protected]" }))).toBeNull();+ expect(getExternalUrl(createIntegration({ externalUrl: "vscode://coolify" }))).toBeNull();+ });++ test("returns null when no app is linked", () => {+ expect(getExternalUrl(createIntegration({}))).toBeNull();+ });+});diff --git a/packages/api/src/router/widgets/coolify.ts b/packages/api/src/router/widgets/coolify.tsindex 7b22f62ee..1603e78c2 100644--- a/packages/api/src/router/widgets/coolify.ts+++ b/packages/api/src/router/widgets/coolify.ts@@ -1,3 +1,4 @@+import { getSafeApplicationUrl, removeTrailingSlash } from "@homarr/common";import type { CoolifyInstanceInfo } from "@homarr/integrations/types";import { mockWidgetData } from "@homarr/integrations";import { coolifyRequestHandler } from "@homarr/request-handler/coolify";@@ -10,11 +11,25 @@ interface CoolifyInstanceResult {integrationId: string;integrationName: string;integrationUrl: string;+ externalUrl: string | null;instanceInfo: CoolifyInstanceInfo | null;updatedAt: Date;error?: string;}+interface CoolifyIntegrationContext {+ externalUrl: string | null;+}++/**+ * Base URL for deep links into the Coolify dashboard: the URL of the linked app, otherwise the integration URL.+ * The integration URL is only used for API requests and can be an internal address.+ */+export const getExternalUrl = (integration: CoolifyIntegrationContext): string | null => {+ const safeUrl = getSafeApplicationUrl(integration.externalUrl);+ return safeUrl ? removeTrailingSlash(safeUrl) : null;+};+export const coolifyRouter = createTRPCRouter({getInstancesInfo: publicProcedure.concat(createManyWidgetIntegrationMiddleware("query", "coolify"))@@ -22,11 +37,14 @@ export const coolifyRouter = createTRPCRouter({return await settleIntegrationQueries(ctx.integrations,async (integration): Promise<CoolifyInstanceResult> => {+ const externalUrl = getExternalUrl(integration);+if (integration.kind === "mock") {return {integrationId: integration.id,integrationName: integration.name,integrationUrl: integration.url,+ externalUrl,instanceInfo: mockWidgetData.coolify,updatedAt: new Date(mockWidgetData.timestamp),};@@ -39,6 +57,7 @@ export const coolifyRouter = createTRPCRouter({integrationId: integration.id,integrationName: integration.name,integrationUrl: integration.url,+ externalUrl,instanceInfo: data,updatedAt: timestamp,};@@ -48,6 +67,7 @@ export const coolifyRouter = createTRPCRouter({integrationId: integration.id,integrationName: integration.name,integrationUrl: integration.url,+ externalUrl: getExternalUrl(integration),instanceInfo: null,updatedAt: new Date(0),error: toPublicIntegrationError(error),diff --git a/packages/widgets/src/coolify/instance-card.tsx b/packages/widgets/src/coolify/instance-card.tsxindex 740a10945..88d96a8ef 100644--- a/packages/widgets/src/coolify/instance-card.tsx+++ b/packages/widgets/src/coolify/instance-card.tsx@@ -42,7 +42,7 @@ export function InstanceCard({ instance, options, isTiny, isAdvanced, widgetKeyinstance.instanceInfo.services,);- const baseUrl = getSafeApplicationUrl(instance.integrationUrl)?.replace(/\/+$/, "") ?? "";+ const baseUrl = getSafeApplicationUrl(instance.externalUrl ?? instance.integrationUrl)?.replace(/\/+$/, "") ?? "";const displayUrl = baseUrl ? baseUrl.replace(/^https?:\/\//, "") : "—";const onlineServers = instance.instanceInfo.servers.filter(isCoolifyServerOnline).length;const runningApps = instance.instanceInfo.applications.filter(diff --git a/packages/widgets/src/coolify/single-instance-layout.tsx b/packages/widgets/src/coolify/single-instance-layout.tsxindex f7efba90e..466864c19 100644--- a/packages/widgets/src/coolify/single-instance-layout.tsx+++ b/packages/widgets/src/coolify/single-instance-layout.tsx@@ -41,7 +41,7 @@ export function SingleInstanceLayout({ instance, options, isTiny, isAdvanced, wiinstance.instanceInfo.services,);- const baseUrl = getSafeApplicationUrl(instance.integrationUrl)?.replace(/\/+$/, "") ?? "";+ const baseUrl = getSafeApplicationUrl(instance.externalUrl ?? instance.integrationUrl)?.replace(/\/+$/, "") ?? "";const displayUrl = baseUrl ? baseUrl.replace(/^https?:\/\//, "") : "—";return (<ScrollArea h="100%">diff --git a/packages/widgets/src/coolify/types.ts b/packages/widgets/src/coolify/types.tsindex 3316c503a..8a5a1736f 100644--- a/packages/widgets/src/coolify/types.ts+++ b/packages/widgets/src/coolify/types.ts@@ -9,6 +9,7 @@ export interface InstanceData {integrationId: string;integrationName: string;integrationUrl: string;+ externalUrl: string | null;instanceInfo: CoolifyInstanceInfo;updatedAt: Date;}