fix: docker hosts and ports env variable wrongly used (#2050)

* fix: docker hosts and ports env variable wrongly used

* fix: ci issues

packages/api/package.json

@@ -29,6 +29,7 @@
     "@homarr/cron-jobs": "workspace:^0.1.0",
     "@homarr/db": "workspace:^0.1.0",
     "@homarr/definitions": "workspace:^0.1.0",
+    "@homarr/docker": "workspace:^0.1.0",
     "@homarr/icons": "workspace:^0.1.0",
     "@homarr/integrations": "workspace:^0.1.0",
     "@homarr/log": "workspace:^",
@@ -42,7 +43,6 @@
     "@trpc/client": "next",
     "@trpc/react-query": "next",
     "@trpc/server": "next",
-    "dockerode": "4.0.2",
     "lodash.clonedeep": "^4.5.0",
     "next": "15.1.6",
     "react": "19.0.0",
@@ -54,7 +54,6 @@
     "@homarr/eslint-config": "workspace:^0.2.0",
     "@homarr/prettier-config": "workspace:^0.1.0",
     "@homarr/tsconfig": "workspace:^0.1.0",
-    "@types/dockerode": "^3.3.34",
     "eslint": "^9.18.0",
     "prettier": "^3.4.2",
     "typescript": "^5.7.3"

packages/api/src/router/docker/docker-router.ts

@@ -1,26 +1,24 @@
 import { TRPCError } from "@trpc/server";
-import type Docker from "dockerode";
-import type { Container } from "dockerode";
 
 import { db, like, or } from "@homarr/db";
 import { icons } from "@homarr/db/schema";
-import type { DockerContainerState } from "@homarr/definitions";
+import { DockerSingleton } from "@homarr/docker";
+import type { Container, ContainerInfo, ContainerState, Docker, Port } from "@homarr/docker";
 import { logger } from "@homarr/log";
 import { createCacheChannel } from "@homarr/redis";
 import { z } from "@homarr/validation";
 
 import { createTRPCRouter, permissionRequiredProcedure } from "../../trpc";
-import { DockerSingleton } from "./docker-singleton";
 
 const dockerCache = createCacheChannel<{
-  containers: (Docker.ContainerInfo & { instance: string; iconUrl: string | null })[];
+  containers: (ContainerInfo & { instance: string; iconUrl: string | null })[];
 }>("docker-containers", 5 * 60 * 1000);
 
 export const dockerRouter = createTRPCRouter({
   getContainers: permissionRequiredProcedure.requiresPermission("admin").query(async () => {
     const result = await dockerCache
       .consumeAsync(async () => {
-        const dockerInstances = DockerSingleton.getInstance();
+        const dockerInstances = DockerSingleton.getInstances();
         const containers = await Promise.all(
           // Return all the containers of all the instances into only one item
           dockerInstances.map(({ instance, host: key }) =>
@@ -33,8 +31,7 @@ export const dockerRouter = createTRPCRouter({
           ),
         ).then((containers) => containers.flat());
 
-        const extractImage = (container: Docker.ContainerInfo) =>
-          container.Image.split("/").at(-1)?.split(":").at(0) ?? "";
+        const extractImage = (container: ContainerInfo) => container.Image.split("/").at(-1)?.split(":").at(0) ?? "";
         const likeQueries = containers.map((container) => like(icons.name, `%${extractImage(container)}%`));
         const dbIcons =
           likeQueries.length >= 1
@@ -151,7 +148,7 @@ const getContainerOrDefaultAsync = async (instance: Docker, id: string) => {
 };
 
 const getContainerOrThrowAsync = async (id: string) => {
-  const dockerInstances = DockerSingleton.getInstance();
+  const dockerInstances = DockerSingleton.getInstances();
   const containers = await Promise.all(dockerInstances.map(({ instance }) => getContainerOrDefaultAsync(instance, id)));
   const foundContainer = containers.find((container) => container) ?? null;
 
@@ -168,21 +165,21 @@ const getContainerOrThrowAsync = async (id: string) => {
 interface DockerContainer {
   name: string;
   id: string;
-  state: DockerContainerState;
+  state: ContainerState;
   image: string;
-  ports: Docker.Port[];
+  ports: Port[];
   iconUrl: string | null;
 }
 
 function sanitizeContainers(
-  containers: (Docker.ContainerInfo & { instance: string; iconUrl: string | null })[],
+  containers: (ContainerInfo & { instance: string; iconUrl: string | null })[],
 ): DockerContainer[] {
   return containers.map((container) => {
     return {
       name: container.Names[0]?.split("/")[1] ?? "Unknown",
       id: container.Id,
       instance: container.instance,
-      state: container.State as DockerContainerState,
+      state: container.State as ContainerState,
       image: container.Image,
       ports: container.Ports,
       iconUrl: container.iconUrl,

packages/api/src/router/docker/docker-singleton.ts

@@ -1,51 +0,0 @@
-import Docker from "dockerode";
-
-interface DockerInstance {
-  host: string;
-  instance: Docker;
-}
-
-export class DockerSingleton {
-  private static instances: DockerInstance[];
-
-  private createInstances() {
-    const instances: DockerInstance[] = [];
-    const hostVariable = process.env.DOCKER_HOST;
-    const portVariable = process.env.DOCKER_PORT;
-    if (hostVariable === undefined || portVariable === undefined) {
-      instances.push({ host: "socket", instance: new Docker() });
-      return instances;
-    }
-    const hosts = hostVariable.split(",");
-    const ports = portVariable.split(",");
-
-    if (hosts.length !== ports.length) {
-      throw new Error("The number of hosts and ports must match");
-    }
-
-    hosts.forEach((host, i) => {
-      instances.push({
-        host: `${host}:${ports[i]}`,
-        instance: new Docker({
-          host,
-          port: parseInt(ports[i] ?? "", 10),
-        }),
-      });
-      return instances;
-    });
-    return instances;
-  }
-
-  public static findInstance(key: string): DockerInstance | undefined {
-    return this.instances.find((instance) => instance.host === key);
-  }
-
-  public static getInstance(): DockerInstance[] {
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (!DockerSingleton.instances) {
-      DockerSingleton.instances = new DockerSingleton().createInstances();
-    }
-
-    return this.instances;
-  }
-}

packages/docker/eslint.config.js

@@ -0,0 +1,9 @@
+import baseConfig from "@homarr/eslint-config/base";
+
+/** @type {import('typescript-eslint').Config} */
+export default [
+  {
+    ignores: [],
+  },
+  ...baseConfig,
+];

packages/docker/index.ts

@@ -0,0 +1 @@
+export * from "./src";

packages/docker/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@homarr/docker",
+  "version": "0.1.0",
+  "private": true,
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": "./index.ts",
+    "./env": "./src/env.ts"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "src/*"
+      ]
+    }
+  },
+  "scripts": {
+    "clean": "rm -rf .turbo node_modules",
+    "format": "prettier --check . --ignore-path ../../.gitignore",
+    "lint": "eslint",
+    "typecheck": "tsc --noEmit"
+  },
+  "prettier": "@homarr/prettier-config",
+  "dependencies": {
+    "@homarr/common": "workspace:^0.1.0",
+    "@t3-oss/env-nextjs": "^0.11.1",
+    "dockerode": "^4.0.4"
+  },
+  "devDependencies": {
+    "@homarr/eslint-config": "workspace:^0.2.0",
+    "@homarr/prettier-config": "workspace:^0.1.0",
+    "@homarr/tsconfig": "workspace:^0.1.0",
+    "@types/dockerode": "^3.3.34",
+    "eslint": "^9.18.0",
+    "typescript": "^5.7.3"
+  }
+}

packages/docker/src/env.ts

@@ -0,0 +1,18 @@
+import { createEnv } from "@t3-oss/env-nextjs";
+import { z } from "zod";
+
+import { shouldSkipEnvValidation } from "@homarr/common/env-validation";
+
+export const env = createEnv({
+  server: {
+    // Comma separated list of docker hostnames that can be used to connect to query the docker endpoints (localhost:2375,host.docker.internal:2375, ...)
+    DOCKER_HOSTNAMES: z.string().optional(),
+    DOCKER_PORTS: z.string().optional(),
+  },
+  runtimeEnv: {
+    DOCKER_HOSTNAMES: process.env.DOCKER_HOSTNAMES,
+    DOCKER_PORTS: process.env.DOCKER_PORTS,
+  },
+  skipValidation: shouldSkipEnvValidation(),
+  emptyStringAsUndefined: true,
+});

packages/docker/src/index.ts

@@ -0,0 +1,10 @@
+import type Docker from "dockerode";
+
+export type { DockerInstance } from "./singleton";
+export { DockerSingleton } from "./singleton";
+export type { ContainerInfo, Container, Port } from "dockerode";
+export type { Docker };
+
+export const containerStates = ["created", "running", "paused", "restarting", "exited", "removing", "dead"] as const;
+
+export type ContainerState = (typeof containerStates)[number];

packages/docker/src/singleton.ts

@@ -0,0 +1,53 @@
+import Docker from "dockerode";
+
+import { env } from "./env";
+
+export interface DockerInstance {
+  host: string;
+  instance: Docker;
+}
+
+export class DockerSingleton {
+  private static instances: DockerInstance[] | null = null;
+
+  private createInstances() {
+    const hostVariable = env.DOCKER_HOSTNAMES;
+    const portVariable = env.DOCKER_PORTS;
+    if (hostVariable === undefined || portVariable === undefined) {
+      return [{ host: "socket", instance: new Docker() }];
+    }
+    const hostnames = hostVariable.split(",");
+    const ports = portVariable.split(",");
+
+    if (hostnames.length !== ports.length) {
+      throw new Error("The number of hosts and ports must match");
+    }
+
+    return hostnames.map((host, i) => {
+      // Check above ensures that ports[i] is not undefined
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const port = ports[i]!;
+
+      return {
+        host: `${host}:${port}`,
+        instance: new Docker({
+          host,
+          port: parseInt(port, 10),
+        }),
+      };
+    });
+  }
+
+  public static findInstance(host: string): DockerInstance | undefined {
+    return this.instances?.find((instance) => instance.host === host);
+  }
+
+  public static getInstances(): DockerInstance[] {
+    if (this.instances) {
+      return this.instances;
+    }
+
+    this.instances = new DockerSingleton().createInstances();
+    return this.instances;
+  }
+}

packages/docker/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@homarr/tsconfig/base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+  },
+  "include": ["*.ts", "src"],
+  "exclude": ["node_modules"]
+}