Merge pull request #748 from automatisch/issue-745

feat: accept username, password, tls for redis configuration

packages/backend/.env-example

@@ -13,5 +13,8 @@ ENCRYPTION_KEY=sample-encryption-key
 APP_SECRET_KEY=sample-app-secret-key
 REDIS_PORT=6379
 REDIS_HOST=127.0.0.1
+REDIS_USERNAME=redis_username
+REDIS_PASSWORD=redis_password
+REDIS_TLS=true
 ENABLE_BULLMQ_DASHBOARD=false
 SERVE_WEB_APP_SEPARATELY=true

packages/backend/src/config/app.ts

@@ -21,6 +21,9 @@ type AppConfig = {
   serveWebAppSeparately: boolean;
   redisHost: string;
   redisPort: number;
+  redisUsername: string;
+  redisPassword: string;
+  redisTls: boolean;
   enableBullMQDashboard: boolean;
   bullMQDashboardUsername: string;
   bullMQDashboardPassword: string;
@@ -55,14 +58,17 @@ const appConfig: AppConfig = {
   postgresUsername:
     process.env.POSTGRES_USERNAME || 'automatisch_development_user',
   postgresPassword: process.env.POSTGRES_PASSWORD,
-  postgresEnableSsl: process.env.POSTGRES_ENABLE_SSL === 'true' ? true : false,
+  postgresEnableSsl: process.env.POSTGRES_ENABLE_SSL === 'true',
   encryptionKey: process.env.ENCRYPTION_KEY || '',
   appSecretKey: process.env.APP_SECRET_KEY || '',
   serveWebAppSeparately,
   redisHost: process.env.REDIS_HOST || '127.0.0.1',
   redisPort: parseInt(process.env.REDIS_PORT || '6379'),
+  redisUsername: process.env.REDIS_USERNAME,
+  redisPassword: process.env.REDIS_PASSWORD,
+  redisTls: process.env.REDIS_TLS === 'true',
   enableBullMQDashboard:
-    process.env.ENABLE_BULLMQ_DASHBOARD === 'true' ? true : false,
+    process.env.ENABLE_BULLMQ_DASHBOARD === 'true',
   bullMQDashboardUsername: process.env.BULLMQ_DASHBOARD_USERNAME,
   bullMQDashboardPassword: process.env.BULLMQ_DASHBOARD_PASSWORD,
   baseUrl,

packages/backend/src/config/redis.ts

@@ -1,9 +1,24 @@
 import appConfig from './app';
 
-const redisConfig = {
+type TRedisConfig = {
+  host: string,
+  port: number,
+  username?: string,
+  password?: string,
+  tls?: Record<string, unknown>,
+  enableOfflineQueue: boolean,
+}
+
+const redisConfig: TRedisConfig = {
   host: appConfig.redisHost,
   port: appConfig.redisPort,
+  username: appConfig.redisUsername,
+  password: appConfig.redisPassword,
   enableOfflineQueue: false,
 };
 
+if (appConfig.redisTls) {
+  redisConfig.tls = {};
+}
+
 export default redisConfig;

packages/docs/pages/advanced/configuration.md

@@ -29,6 +29,9 @@ Please be careful with the `ENCRYPTION_KEY` environment variable. It is used to
 | `APP_SECRET_KEY`            | string  |                    | Secret Key to authenticate the user |
 | `REDIS_HOST`                | string  | `redis`            | Redis Host                          |
 | `REDIS_PORT`                | number  | `6379`             | Redis Port                          |
+| `REDIS_USERNAME`            | string  | ``                 | Redis Username                      |
+| `REDIS_PASSWORD`            | string  | ``                 | Redis Password                      |
+| `REDIS_TLS`                 | boolean | `false`            | Redis TLS                           |
 | `TELEMETRY_ENABLED`         | boolean | `true`             | Enable/Disable Telemetry            |
 | `ENABLE_BULLMQ_DASHBOARD`   | boolean | `false`            | Enable BullMQ Dashboard             |
 | `BULLMQ_DASHBOARD_USERNAME` | string  |                    | Username to login BullMQ Dashboard  |