feat(integrations): add Coolify integration and widget (#4789)

Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
This commit is contained in:
Rhiz3KandMeier Lukas authored and GitHub committed 2026-01-23 19:09:53 +01:00
1 parent 0ef3046d65
commit 81dac58005
25 files changed
+1701 -3

No files matched your search

@@ -2,6 +2,7 @@ import type { IntegrationKind } from "@homarr/definitions";
import { AdGuardHomeIntegration } from "../adguard-home/adguard-home-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";
@@ -103,6 +104,7 @@ export const integrationCreators = {
mock: MockIntegration,
truenas: TrueNasIntegration,
unraid: UnraidIntegration,
coolify: CoolifyIntegration,
} satisfies Record<IntegrationKind, IntegrationInstance | [(input: IntegrationInput) => Promise<Integration>]>;
type IntegrationInstanceOfKind<TKind extends keyof typeof integrationCreators> = {
@@ -0,0 +1,351 @@
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 type { TestingResult } from "../base/test-connection/test-connection-service";
import type {
CoolifyApplication,
CoolifyApplicationWithContext,
CoolifyEnvironment,
CoolifyEnvironmentVariable,
CoolifyHealthcheck,
CoolifyInstanceInfo,
CoolifyProject,
CoolifyProjectWithEnvironments,
CoolifyResource,
CoolifyServer,
CoolifyService,
CoolifyServiceWithContext,
} from "./coolify-types";
import {
coolifyApplicationLogSchema,
coolifyApplicationSchema,
coolifyEnvironmentSchema,
coolifyEnvironmentVariableSchema,
coolifyHealthcheckSchema,
coolifyProjectSchema,
coolifyProjectWithEnvironmentsSchema,
coolifyResourceSchema,
coolifyServerSchema,
coolifyServiceSchema,
} from "./coolify-types";
export class CoolifyIntegration extends Integration {
protected async testingAsync(input: IntegrationTestingInput): Promise<TestingResult> {
const healthUrl = this.url("/api/health");
const healthResponse = await input.fetchAsync(healthUrl, {});
if (!healthResponse.ok) {
throw new ResponseError(healthResponse);
}
// Test API key authentication
const versionUrl = this.url("/api/v1/version");
const versionResponse = await input.fetchAsync(versionUrl, {
headers: this.getAuthHeaders(),
});
if (!versionResponse.ok) {
throw new ResponseError(versionResponse);
}
return { success: true };
}
/**
* Get Coolify version information
* https://coolify.io/docs/api-reference/api/operations/version
*/
public async getVersionAsync(): Promise<string> {
const url = this.url("/api/v1/version");
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
const version = await response.text();
return version.trim();
}
/**
* Get Coolify healthcheck status
* https://coolify.io/docs/api-reference/api/operations/healthcheck
*/
public async getHealthcheckAsync(): Promise<CoolifyHealthcheck> {
const url = this.url("/api/v1/healthcheck");
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyHealthcheckSchema.parse(await response.json());
}
/**
* List all applications
* https://coolify.io/docs/api-reference/api/operations/list-applications
*/
public async listApplicationsAsync(): Promise<CoolifyApplication[]> {
const url = this.url("/api/v1/applications");
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyApplicationSchema.array().parse(await response.json());
}
/**
* Get application by UUID
* https://coolify.io/docs/api-reference/api/operations/get-application-by-uuid
*/
public async getApplicationByUuidAsync(uuid: string): Promise<CoolifyApplication> {
const url = this.url(`/api/v1/applications/${uuid}`);
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyApplicationSchema.parse(await response.json());
}
/**
* Get application logs by UUID
* https://coolify.io/docs/api-reference/api/operations/get-application-logs-by-uuid
*/
public async getApplicationLogsAsync(uuid: string): Promise<string> {
const url = this.url(`/api/v1/applications/${uuid}/logs`);
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
const result = coolifyApplicationLogSchema.parse(await response.json());
return result.logs;
}
/**
* List environment variables by application UUID
* https://coolify.io/docs/api-reference/api/operations/list-envs-by-application-uuid
*/
public async listEnvsByApplicationUuidAsync(uuid: string): Promise<CoolifyEnvironmentVariable[]> {
const url = this.url(`/api/v1/applications/${uuid}/envs`);
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyEnvironmentVariableSchema.array().parse(await response.json());
}
/**
* List projects
* https://coolify.io/docs/api-reference/api/operations/list-projects
*/
public async listProjectsAsync(): Promise<CoolifyProject[]> {
const url = this.url("/api/v1/projects");
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyProjectSchema.array().parse(await response.json());
}
/**
* Get project by UUID (includes environments)
* https://coolify.io/docs/api-reference/api/operations/get-project-by-uuid
*/
public async getProjectByUuidAsync(uuid: string): Promise<CoolifyProjectWithEnvironments> {
const url = this.url(`/api/v1/projects/${uuid}`);
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyProjectWithEnvironmentsSchema.parse(await response.json());
}
/**
* Get environments
* https://coolify.io/docs/api-reference/api/operations/get-environments
*/
public async getEnvironmentsAsync(): Promise<CoolifyEnvironment[]> {
const url = this.url("/api/v1/environments");
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyEnvironmentSchema.array().parse(await response.json());
}
/**
* Get environment by name or UUID
* https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid
*/
public async getEnvironmentByNameOrUuidAsync(nameOrUuid: string): Promise<CoolifyEnvironment> {
const url = this.url(`/api/v1/environments/${nameOrUuid}`);
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyEnvironmentSchema.parse(await response.json());
}
/**
* List resources
* https://coolify.io/docs/api-reference/api/operations/list-resources
*/
public async listResourcesAsync(): Promise<CoolifyResource[]> {
const url = this.url("/api/v1/resources");
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyResourceSchema.array().parse(await response.json());
}
/**
* List servers
* https://coolify.io/docs/api-reference/api/operations/list-servers
*/
public async listServersAsync(): Promise<CoolifyServer[]> {
const url = this.url("/api/v1/servers");
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyServerSchema.array().parse(await response.json());
}
/**
* List services
* https://coolify.io/docs/api-reference/api/operations/list-services
*/
public async listServicesAsync(): Promise<CoolifyService[]> {
const url = this.url("/api/v1/services");
const response = await fetchWithTrustedCertificatesAsync(url, {
headers: this.getAuthHeaders(),
});
if (!response.ok) {
throw new ResponseError(response);
}
return coolifyServiceSchema.array().parse(await response.json());
}
public async getInstanceInfoAsync(): Promise<CoolifyInstanceInfo> {
const [version, applications, services, projectsWithEnvs, servers] = await Promise.all([
this.getVersionAsync(),
this.listApplicationsAsync(),
this.listServicesAsync(),
this.listProjectsWithEnvironmentsAsync(),
this.listServersAsync(),
]);
const envToProjectMap = new Map<
number,
{ projectName: string; projectUuid: string; environmentName: string; environmentUuid?: string }
>();
for (const project of projectsWithEnvs) {
for (const env of project.environments ?? []) {
if (env.id != null) {
envToProjectMap.set(env.id, {
projectName: project.name,
projectUuid: project.uuid,
environmentName: env.name,
environmentUuid: env.uuid ?? undefined,
});
}
}
}
const applicationsWithContext: CoolifyApplicationWithContext[] = applications.map((app) => {
const context = app.environment_id ? envToProjectMap.get(app.environment_id) : undefined;
return {
...app,
projectName: context?.projectName,
projectUuid: context?.projectUuid,
environmentName: context?.environmentName,
environmentUuid: context?.environmentUuid,
};
});
const servicesWithContext: CoolifyServiceWithContext[] = services.map((service) => {
const context = service.environment_id ? envToProjectMap.get(service.environment_id) : undefined;
const fqdn = service.fqdn ?? service.applications?.find((app) => app.fqdn)?.fqdn ?? undefined;
return {
...service,
fqdn,
projectName: context?.projectName,
projectUuid: context?.projectUuid,
environmentName: context?.environmentName,
environmentUuid: context?.environmentUuid,
};
});
return {
version,
applications: applicationsWithContext,
services: servicesWithContext,
servers,
};
}
/**
* List all projects with their environments
*/
private async listProjectsWithEnvironmentsAsync(): Promise<CoolifyProjectWithEnvironments[]> {
const projects = await this.listProjectsAsync();
const projectsWithEnvs = await Promise.all(projects.map((project) => this.getProjectByUuidAsync(project.uuid)));
return projectsWithEnvs;
}
private getAuthHeaders(): Record<string, string> {
return {
Authorization: `Bearer ${this.getSecretValue("apiKey")}`,
};
}
}
@@ -0,0 +1,154 @@
// Coolify API Types and Schemas based on https://coolify.io/docs/api-reference/api
import { z } from "zod/v4";
// Health check schema
export const coolifyHealthcheckSchema = z.object({
status: z.string(),
});
export type CoolifyHealthcheck = z.infer<typeof coolifyHealthcheckSchema>;
// Application log schema
export const coolifyApplicationLogSchema = z.object({
logs: z.string(),
});
export type CoolifyApplicationLog = z.infer<typeof coolifyApplicationLogSchema>;
// Environment variable schema
export const coolifyEnvironmentVariableSchema = z.object({
id: z.number().nullish(),
key: z.string(),
value: z.string(),
is_build_time: z.boolean().nullish(),
is_preview: z.boolean().nullish(),
application_id: z.number().nullish(),
});
export type CoolifyEnvironmentVariable = z.infer<typeof coolifyEnvironmentVariableSchema>;
// Application schema (only fields used in the widget)
export const coolifyApplicationSchema = z.object({
id: z.number().nullish(),
uuid: z.string(),
name: z.string(),
status: z.string().nullish(),
fqdn: z.string().nullish(),
environment_id: z.number().nullish(),
server_id: z.number().nullish(),
destination_id: z.number().nullish(),
updated_at: z.string().nullish(),
last_online_at: z.string().nullish(),
});
export type CoolifyApplication = z.infer<typeof coolifyApplicationSchema>;
// Project schema
export const coolifyProjectSchema = z.object({
id: z.number().nullish(),
uuid: z.string(),
name: z.string(),
});
export type CoolifyProject = z.infer<typeof coolifyProjectSchema>;
// Environment schema
export const coolifyEnvironmentSchema = z.object({
id: z.number().nullish(),
uuid: z.string().nullish(),
name: z.string(),
project_id: z.number().nullish(),
});
export type CoolifyEnvironment = z.infer<typeof coolifyEnvironmentSchema>;
// Project with environments schema
export const coolifyProjectWithEnvironmentsSchema = coolifyProjectSchema.extend({
environments: z.array(coolifyEnvironmentSchema).nullish(),
});
export type CoolifyProjectWithEnvironments = z.infer<typeof coolifyProjectWithEnvironmentsSchema>;
// Resource schema
export const coolifyResourceSchema = z.object({
id: z.number().nullish(),
uuid: z.string(),
name: z.string(),
type: z.string(),
status: z.string().nullish(),
});
export type CoolifyResource = z.infer<typeof coolifyResourceSchema>;
// Server settings schema
export const coolifyServerSettingsSchema = z.object({
server_id: z.number().nullish(),
is_build_server: z.boolean().nullish(),
is_reachable: z.boolean().nullish(),
is_usable: z.boolean().nullish(),
});
export type CoolifyServerSettings = z.infer<typeof coolifyServerSettingsSchema>;
// Server schema
export const coolifyServerSchema = z.object({
id: z.number().nullish(),
uuid: z.string(),
name: z.string(),
ip: z.string().nullish(),
is_reachable: z.boolean().nullish(),
is_usable: z.boolean().nullish(),
settings: coolifyServerSettingsSchema.nullish(),
});
export type CoolifyServer = z.infer<typeof coolifyServerSchema>;
// Service application schema (nested in services)
export const coolifyServiceApplicationSchema = z.object({
id: z.number().nullish(),
uuid: z.string(),
name: z.string(),
fqdn: z.string().nullish(),
status: z.string().nullish(),
});
export type CoolifyServiceApplication = z.infer<typeof coolifyServiceApplicationSchema>;
// Service schema
export const coolifyServiceSchema = z.object({
id: z.number().nullish(),
uuid: z.string(),
name: z.string(),
status: z.string().nullish(),
fqdn: z.string().nullish(),
environment_id: z.number().nullish(),
server_id: z.number().nullish(),
destination_id: z.number().nullish(),
updated_at: z.string().nullish(),
applications: z.array(coolifyServiceApplicationSchema).nullish(),
});
export type CoolifyService = z.infer<typeof coolifyServiceSchema>;
// Extended types with context (not from API, added by integration)
export interface CoolifyApplicationWithContext extends CoolifyApplication {
projectName?: string;
projectUuid?: string;
environmentName?: string;
environmentUuid?: string;
}
export interface CoolifyServiceWithContext extends CoolifyService {
projectName?: string;
projectUuid?: string;
environmentName?: string;
environmentUuid?: string;
}
// Aggregated information for the Coolify instance
export interface CoolifyInstanceInfo {
version: string;
applications: CoolifyApplicationWithContext[];
services: CoolifyServiceWithContext[];
servers: CoolifyServer[];
}
@@ -0,0 +1,313 @@
import { Request, Response } from "undici";
import { beforeEach, describe, expect, test, vi } from "vitest";
import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
import { CoolifyIntegration } from "../coolify-integration";
import type {
CoolifyApplication,
CoolifyProject,
CoolifyProjectWithEnvironments,
CoolifyServer,
CoolifyService,
} from "../coolify-types";
vi.mock("@homarr/core/infrastructure/http", () => ({
fetchWithTrustedCertificatesAsync: vi.fn(),
}));
const TEST_API_KEY = "test-api-key-12345";
const TEST_URL = "https://coolify.example.com";
type MockResponseData = string | Record<string, unknown> | unknown[];
const mockFetchWithTrustedCertificates = vi.mocked(fetchWithTrustedCertificatesAsync);
const setupMockFetch = (responses: Record<string, MockResponseData>) => {
mockFetchWithTrustedCertificates.mockImplementation((url) => {
const urlString = typeof url === "string" ? url : url instanceof Request ? url.url : url.toString();
const urlObj = new URL(urlString);
const path = urlObj.pathname;
if (path in responses) {
const data = responses[path];
const body = typeof data === "string" ? data : JSON.stringify(data);
return Promise.resolve(
new Response(body, {
status: 200,
headers: { "content-type": "application/json" },
}) as unknown as Awaited<ReturnType<typeof fetchWithTrustedCertificatesAsync>>,
);
}
return Promise.resolve(
new Response(JSON.stringify({ error: "Not Found" }), {
status: 404,
headers: { "content-type": "application/json" },
}) as unknown as Awaited<ReturnType<typeof fetchWithTrustedCertificatesAsync>>,
);
});
};
const createCoolifyIntegration = () => {
return new CoolifyIntegration({
id: "test-coolify",
name: "Test Coolify",
url: TEST_URL,
externalUrl: null,
decryptedSecrets: [{ kind: "apiKey", value: TEST_API_KEY }],
});
};
describe("CoolifyIntegration", () => {
beforeEach(() => {
vi.clearAllMocks();
});
describe("getVersionAsync", () => {
test("should return version string from Coolify API", async () => {
setupMockFetch({
"/api/v1/version": "4.0.0-beta.460",
});
const integration = createCoolifyIntegration();
const result = await integration.getVersionAsync();
expect(result).toBe("4.0.0-beta.460");
expect(mockFetchWithTrustedCertificates).toHaveBeenCalled();
});
test("should throw error when API returns error", async () => {
mockFetchWithTrustedCertificates.mockResolvedValue(
new Response("Unauthorized", {
status: 401,
headers: { "content-type": "text/plain" },
}) as unknown as Awaited<ReturnType<typeof fetchWithTrustedCertificatesAsync>>,
);
const integration = createCoolifyIntegration();
await expect(integration.getVersionAsync()).rejects.toThrow();
});
});
describe("listServersAsync", () => {
test("should return list of servers", async () => {
const servers: CoolifyServer[] = [
{
id: 1,
uuid: "server-uuid-1",
name: "Production Server",
ip: "192.168.1.100",
is_reachable: true,
is_usable: true,
settings: { is_build_server: false },
},
{
id: 2,
uuid: "server-uuid-2",
name: "Build Server",
ip: "192.168.1.101",
is_reachable: true,
is_usable: true,
settings: { is_build_server: true },
},
];
setupMockFetch({
"/api/v1/servers": servers,
});
const integration = createCoolifyIntegration();
const result = await integration.listServersAsync();
expect(result).toHaveLength(2);
expect(result[0]?.name).toBe("Production Server");
expect(result[1]?.settings?.is_build_server).toBe(true);
});
});
describe("listApplicationsAsync", () => {
test("should return list of applications", async () => {
const applications: CoolifyApplication[] = [
{
id: 1,
uuid: "app-uuid-1",
name: "my-app",
fqdn: "https://myapp.example.com",
status: "running",
updated_at: "2024-01-01T00:00:00Z",
},
{
id: 2,
uuid: "app-uuid-2",
name: "another-app",
fqdn: "https://another.example.com",
status: "stopped",
updated_at: "2024-01-01T00:00:00Z",
},
];
setupMockFetch({
"/api/v1/applications": applications,
});
const integration = createCoolifyIntegration();
const result = await integration.listApplicationsAsync();
expect(result).toHaveLength(2);
expect(result[0]?.status).toBe("running");
expect(result[1]?.status).toBe("stopped");
});
});
describe("listServicesAsync", () => {
test("should return list of services", async () => {
const services: CoolifyService[] = [
{
id: 1,
uuid: "service-uuid-1",
name: "postgresql",
updated_at: "2024-01-01T00:00:00Z",
},
];
setupMockFetch({
"/api/v1/services": services,
});
const integration = createCoolifyIntegration();
const result = await integration.listServicesAsync();
expect(result).toHaveLength(1);
expect(result[0]?.name).toBe("postgresql");
});
});
describe("listProjectsAsync", () => {
test("should return list of projects", async () => {
const projects: CoolifyProject[] = [
{
id: 1,
uuid: "proj-uuid-1",
name: "Production",
},
];
setupMockFetch({
"/api/v1/projects": projects,
});
const integration = createCoolifyIntegration();
const result = await integration.listProjectsAsync();
expect(result).toHaveLength(1);
expect(result[0]?.name).toBe("Production");
});
});
describe("getInstanceInfoAsync", () => {
test("should aggregate all instance data with project context", async () => {
const projectWithEnvs: CoolifyProjectWithEnvironments = {
id: 1,
uuid: "proj-uuid-1",
name: "Production",
environments: [
{
id: 1,
uuid: "env-uuid-1",
name: "production",
project_id: 1,
},
],
};
setupMockFetch({
"/api/v1/version": "4.0.0-beta.460",
"/api/v1/applications": [
{
id: 1,
uuid: "app-uuid-1",
name: "my-app",
status: "running",
environment_id: 1,
updated_at: "2024-01-01T00:00:00Z",
},
],
"/api/v1/services": [
{
id: 1,
uuid: "service-uuid-1",
name: "postgres",
environment_id: 1,
updated_at: "2024-01-01T00:00:00Z",
},
],
"/api/v1/projects": [
{
id: 1,
uuid: "proj-uuid-1",
name: "Production",
},
],
"/api/v1/servers": [
{
id: 1,
uuid: "server-uuid-1",
name: "Server 1",
ip: "192.168.1.1",
is_reachable: true,
is_usable: true,
settings: { is_build_server: false },
},
],
"/api/v1/projects/proj-uuid-1": projectWithEnvs,
});
const integration = createCoolifyIntegration();
const result = await integration.getInstanceInfoAsync();
expect(result.version).toBe("4.0.0-beta.460");
expect(result.applications).toHaveLength(1);
expect(result.services).toHaveLength(1);
expect(result.servers).toHaveLength(1);
expect(result.applications[0]?.projectName).toBe("Production");
expect(result.applications[0]?.environmentName).toBe("production");
});
});
describe("getHealthcheckAsync", () => {
test("should return healthcheck status", async () => {
setupMockFetch({
"/api/v1/healthcheck": { status: "healthy" },
});
const integration = createCoolifyIntegration();
const result = await integration.getHealthcheckAsync();
expect(result.status).toBe("healthy");
});
});
describe("getApplicationByUuidAsync", () => {
test("should return application details by UUID", async () => {
const application: CoolifyApplication = {
id: 1,
uuid: "app-uuid-1",
name: "my-app",
fqdn: "https://app.example.com",
status: "running",
updated_at: "2024-01-01T00:00:00Z",
};
setupMockFetch({
"/api/v1/applications/app-uuid-1": application,
});
const integration = createCoolifyIntegration();
const result = await integration.getApplicationByUuidAsync("app-uuid-1");
expect(result.uuid).toBe("app-uuid-1");
expect(result.name).toBe("my-app");
});
});
});
+1
View File
@@ -25,6 +25,7 @@ export { TrueNasIntegration } from "./truenas/truenas-integration";
export { UnraidIntegration } from "./unraid/unraid-integration";
export { OPNsenseIntegration } from "./opnsense/opnsense-integration";
export { ICalIntegration } from "./ical/ical-integration";
export { CoolifyIntegration } from "./coolify/coolify-integration";
// Types
export type { IntegrationInput } from "./base/integration";
+1
View File
@@ -11,3 +11,4 @@ export * from "./proxmox/proxmox-types";
export * from "./unifi-controller/unifi-controller-types";
export * from "./opnsense/opnsense-types";
export * from "./interfaces/media-releases";
export * from "./coolify/coolify-types";