feat(infra): add external redis (#3639)

packages/auth/env.ts

@@ -1,8 +1,7 @@
 import { z } from "zod";
 
+import { createBooleanSchema, createDurationSchema, createEnv } from "@homarr/core/infrastructure/env";
 import { supportedAuthProviders } from "@homarr/definitions";
-import { createEnv } from "@homarr/env";
-import { createBooleanSchema, createDurationSchema } from "@homarr/env/schemas";
 
 const authProvidersSchema = z
   .string()

packages/auth/package.json

@@ -27,9 +27,9 @@
     "@auth/drizzle-adapter": "^1.10.0",
     "@homarr/certificates": "workspace:^0.1.0",
     "@homarr/common": "workspace:^0.1.0",
+    "@homarr/core": "workspace:^0.1.0",
     "@homarr/db": "workspace:^0.1.0",
     "@homarr/definitions": "workspace:^0.1.0",
-    "@homarr/env": "workspace:^0.1.0",
     "@homarr/log": "workspace:^0.1.0",
     "@homarr/validation": "workspace:^0.1.0",
     "bcrypt": "^6.0.0",

packages/common/env.ts

@@ -1,7 +1,7 @@
 import { randomBytes } from "crypto";
 import { z } from "zod";
 
-import { createEnv } from "@homarr/env";
+import { createEnv } from "@homarr/core/infrastructure/env";
 
 const errorSuffix = `, please generate a 64 character secret in hex format or use the following: "${randomBytes(32).toString("hex")}"`;
 

packages/common/package.json

@@ -27,7 +27,7 @@
   },
   "prettier": "@homarr/prettier-config",
   "dependencies": {
-    "@homarr/env": "workspace:^0.1.0",
+    "@homarr/core": "workspace:^0.1.0",
     "@homarr/log": "workspace:^0.1.0",
     "@paralleldrive/cuid2": "^2.2.2",
     "dayjs": "^1.11.13",

packages/core/eslint.config.js

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

packages/core/package.json

@@ -1,12 +1,13 @@
 {
-  "name": "@homarr/env",
+  "name": "@homarr/core",
   "version": "0.1.0",
   "private": true,
   "license": "Apache-2.0",
   "type": "module",
   "exports": {
-    ".": "./index.ts",
-    "./schemas": "./src/schemas.ts"
+    "./infrastructure/redis": "./src/infrastructure/redis/client.ts",
+    "./infrastructure/env": "./src/infrastructure/env/index.ts",
+    ".": "./src/index.ts"
   },
   "typesVersions": {
     "*": {
@@ -24,6 +25,7 @@
   "prettier": "@homarr/prettier-config",
   "dependencies": {
     "@t3-oss/env-nextjs": "^0.13.8",
+    "ioredis": "5.6.1",
     "zod": "^3.25.76"
   },
   "devDependencies": {

packages/core/src/infrastructure/env/index.ts

@@ -7,3 +7,6 @@ export const defaultEnvOptions = {
 } satisfies Partial<Parameters<typeof createEnvT3>[0]>;
 
 export const createEnv: typeof createEnvT3 = (options) => createEnvT3({ ...defaultEnvOptions, ...options });
+
+export * from "./prefix";
+export * from "./schemas";

packages/core/src/infrastructure/env/prefix.ts

@@ -0,0 +1,13 @@
+export const runtimeEnvWithPrefix = (prefix: `${string}_`) =>
+  Object.entries(process.env)
+    .filter(([key]) => key.startsWith(prefix))
+    .reduce(
+      (acc, [key, value]) => {
+        if (value === undefined) return acc;
+
+        const newKey = key.replace(prefix, "");
+        acc[newKey] = value;
+        return acc;
+      },
+      {} as Record<string, string>,
+    );

packages/core/src/infrastructure/redis/client.ts

@@ -0,0 +1,26 @@
+import type { RedisOptions } from "ioredis";
+import { Redis } from "ioredis";
+
+import { redisEnv } from "./env";
+
+const defaultRedisOptions = {
+  connectionName: "homarr",
+} satisfies RedisOptions;
+
+export type { Redis as RedisClient } from "ioredis";
+
+export const createRedisClient = () =>
+  redisEnv.IS_EXTERNAL
+    ? new Redis({
+        ...defaultRedisOptions,
+        host: redisEnv.HOST,
+        port: redisEnv.PORT,
+        tls: redisEnv.TLS_CA
+          ? {
+              ca: redisEnv.TLS_CA,
+            }
+          : undefined,
+        username: redisEnv.USERNAME,
+        password: redisEnv.PASSWORD,
+      })
+    : new Redis(defaultRedisOptions);

packages/core/src/infrastructure/redis/env.ts

@@ -0,0 +1,17 @@
+import { z } from "zod/v4";
+
+import { createEnv } from "../env";
+import { runtimeEnvWithPrefix } from "../env/prefix";
+import { createBooleanSchema } from "../env/schemas";
+
+export const redisEnv = createEnv({
+  server: {
+    IS_EXTERNAL: createBooleanSchema(false),
+    HOST: z.string().optional(),
+    PORT: z.coerce.number().default(6379).optional(),
+    TLS_CA: z.string().optional(),
+    USERNAME: z.string().optional(),
+    PASSWORD: z.string().optional(),
+  },
+  runtimeEnv: runtimeEnvWithPrefix("REDIS_"),
+});

packages/cron-job-api/package.json

@@ -26,8 +26,8 @@
   "prettier": "@homarr/prettier-config",
   "dependencies": {
     "@homarr/common": "workspace:^0.1.0",
+    "@homarr/core": "workspace:^0.1.0",
     "@homarr/cron-jobs": "workspace:^0.1.0",
-    "@homarr/env": "workspace:^0.1.0",
     "@homarr/log": "workspace:^0.1.0",
     "@tanstack/react-query": "^5.83.0",
     "@trpc/client": "^11.4.3",

packages/cron-job-api/src/env.ts

@@ -1,7 +1,7 @@
 import { z } from "zod/v4";
 
 import { env as commonEnv } from "@homarr/common/env";
-import { createEnv } from "@homarr/env";
+import { createEnv } from "@homarr/core/infrastructure/env";
 
 export const env = createEnv({
   server: {

packages/db/env.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
 
 import { env as commonEnv } from "@homarr/common/env";
-import { createEnv } from "@homarr/env";
+import { createEnv } from "@homarr/core/infrastructure/env";
 
 const drivers = {
   betterSqlite3: "better-sqlite3",

packages/db/package.json

@@ -40,8 +40,8 @@
   "dependencies": {
     "@auth/core": "^0.40.0",
     "@homarr/common": "workspace:^0.1.0",
+    "@homarr/core": "workspace:^0.1.0",
     "@homarr/definitions": "workspace:^0.1.0",
-    "@homarr/env": "workspace:^0.1.0",
     "@homarr/log": "workspace:^0.1.0",
     "@homarr/server-settings": "workspace:^0.1.0",
     "@mantine/core": "^8.1.3",

packages/docker/package.json

@@ -25,7 +25,7 @@
   "prettier": "@homarr/prettier-config",
   "dependencies": {
     "@homarr/common": "workspace:^0.1.0",
-    "@homarr/env": "workspace:^0.1.0",
+    "@homarr/core": "workspace:^0.1.0",
     "dockerode": "^4.0.7"
   },
   "devDependencies": {

packages/docker/src/env.ts

@@ -1,7 +1,6 @@
 import { z } from "zod";
 
-import { createEnv } from "@homarr/env";
-import { createBooleanSchema } from "@homarr/env/schemas";
+import { createBooleanSchema, createEnv } from "@homarr/core/infrastructure/env";
 
 export const env = createEnv({
   server: {

packages/env/index.ts

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

packages/log/package.json

@@ -24,8 +24,7 @@
   },
   "prettier": "@homarr/prettier-config",
   "dependencies": {
-    "@homarr/env": "workspace:^0.1.0",
-    "ioredis": "5.6.1",
+    "@homarr/core": "workspace:^0.1.0",
     "superjson": "2.2.2",
     "winston": "3.17.0",
     "zod": "^3.25.76"

packages/log/src/env.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 
-import { createEnv } from "@homarr/env";
+import { createEnv } from "@homarr/core/infrastructure/env";
 
 import { logLevels } from "./constants";
 

packages/log/src/redis-transport.ts

@@ -1,7 +1,9 @@
-import { Redis } from "ioredis";
 import superjson from "superjson";
 import Transport from "winston-transport";
 
+import type { RedisClient } from "@homarr/core/infrastructure/redis";
+import { createRedisClient } from "@homarr/core/infrastructure/redis";
+
 const messageSymbol = Symbol.for("message");
 const levelSymbol = Symbol.for("level");
 
@@ -10,7 +12,7 @@ const levelSymbol = Symbol.for("level");
 // of the base functionality and `.exceptions.handle()`.
 //
 export class RedisTransport extends Transport {
-  private redis: Redis | null = null;
+  private redis: RedisClient | null = null;
 
   /**
    * Log the info to the Redis channel
@@ -21,7 +23,7 @@ export class RedisTransport extends Transport {
     });
 
     // Is only initialized here because it did not work when initialized in the constructor or outside the class
-    this.redis ??= new Redis();
+    this.redis ??= createRedisClient();
 
     this.redis
       .publish(

packages/redis/package.json

@@ -23,6 +23,8 @@
   "prettier": "@homarr/prettier-config",
   "dependencies": {
     "@homarr/common": "workspace:^",
+    "@homarr/core": "workspace:^",
+    "@homarr/db": "workspace:^",
     "@homarr/definitions": "workspace:^",
     "@homarr/log": "workspace:^",
     "ioredis": "5.6.1",

packages/redis/src/lib/connection.ts

@@ -1,4 +1,5 @@
-import { Redis } from "ioredis";
+import type { RedisClient } from "@homarr/core/infrastructure/redis";
+import { createRedisClient } from "@homarr/core/infrastructure/redis";
 
 /**
  * Creates a new Redis connection
@@ -7,8 +8,8 @@ import { Redis } from "ioredis";
 export const createRedisConnection = () => {
   if (Boolean(process.env.CI) || Boolean(process.env.DISABLE_REDIS_LOGS)) {
     // Return null if we are in CI as we don't want to connect to Redis
-    return null as unknown as Redis;
+    return null as unknown as RedisClient;
   }
 
-  return new Redis();
+  return createRedisClient();
 };