feat: add support for CHouse UI in Docker service and UI

Author: pascal-klesse

projects/api/src/server/common/services/docker.service.ts

@@ -24,6 +24,7 @@ import { getAdminer } from "../../modules/container/types/service/adminer/compos
 import { getDirectus } from "../../modules/container/types/service/directus/compose";
 import { getMongoExpress } from "../../modules/container/types/service/mongo-express/compose";
 import { getPlausible } from "../../modules/container/types/service/plausible/compose";
+import { getChouseUi } from "../../modules/container/types/service/chouse-ui/compose";
 import { getClickhouseUi } from "../../modules/container/types/service/clickhouse-ui/compose";
 import { getRedisUi } from "../../modules/container/types/service/redis-ui/compose";
 import { getRocketAdmin } from "../../modules/container/types/service/rocketadmin/compose";
@@ -122,6 +123,34 @@ export class DockerService {
       case ServiceType.ADMINER:
         compose = await getAdminer(container);
         break;
+      case ServiceType.CHOUSE_UI:
+        if (!container.env) {
+          const jwtSecret = randomBytes(32).toString('hex');
+          const encryptionKey = randomBytes(32).toString('hex');
+
+          container.env = `
+# Core Settings
+PORT=5521
+NODE_ENV=production
+
+# Authentication & Security
+JWT_SECRET=${jwtSecret}
+RBAC_ENCRYPTION_KEY=${encryptionKey}
+RBAC_ADMIN_PASSWORD=admin123!
+
+# Database (SQLite by default)
+RBAC_DB_TYPE=sqlite
+RBAC_SQLITE_PATH=/app/data/rbac.db
+
+# For PostgreSQL, uncomment and configure:
+# RBAC_DB_TYPE=postgres
+# RBAC_POSTGRES_URL=postgres://user:password@host:5432/dbname
+`;
+          await this.containerService.updateForce(container.id, { env: container.env });
+          await this.createEnvFile(container);
+        }
+        compose = await getChouseUi(container);
+        break;
       case ServiceType.CLICKHOUSE_UI:
         if (!container.env) {
           container.env = `

projects/api/src/server/modules/container/enums/all-container-types.enum.ts

@@ -2,6 +2,7 @@ import {registerEnumType} from '@nestjs/graphql';
 
 export enum AllContainerTypes {
   ADMINER = 'ADMINER',
+  CHOUSE_UI = 'CHOUSE_UI',
   CLICKHOUSE_UI = 'CLICKHOUSE_UI',
   CUSTOM = 'CUSTOM',
   DIRECTUS = 'DIRECTUS',

projects/api/src/server/modules/container/enums/service-type.enum.ts

@@ -2,6 +2,7 @@ import {registerEnumType} from '@nestjs/graphql';
 
 export enum ServiceType {
   ADMINER = 'ADMINER',
+  CHOUSE_UI = 'CHOUSE_UI',
   CLICKHOUSE_UI = 'CLICKHOUSE_UI',
   CUSTOM = 'CUSTOM',
   DIRECTUS = 'DIRECTUS',

projects/api/src/server/modules/container/types/service/chouse-ui/compose.ts

@@ -0,0 +1,64 @@
+import {Container} from '../../../container.model';
+import {execa} from 'execa';
+
+export async function getChouseUi(container: Container): Promise<string> {
+  const basicAuth = !!(container?.basicAuth?.username && container?.basicAuth?.pw);
+  const additionalLabels = [];
+  const middlewares = ['secure-headers@swarm'];
+
+  if (basicAuth) {
+    const {stdout: creds} = await execa(
+      `echo $(htpasswd -nb ${container.basicAuth.username} ${container.basicAuth.pw})`,
+      {shell: true}
+    );
+    additionalLabels.push(`        - traefik.http.middlewares.${container.id}-auth.basicauth.users=${creds.replace(/\$/gi, '$$$')}`);
+    middlewares.unshift(`${container.id}-auth`);
+  }
+
+  return `
+    networks:
+      traefik-public:
+        external: true
+      deploy-party:
+        external: true
+
+    services:
+      chouse-ui:
+        image: ghcr.io/daun-gatal/chouse-ui:${container.buildImage || 'latest'}
+        labels:
+          - deploy.party.id=${container.id}
+        env_file:
+          - .env
+        networks:
+          - traefik-public
+          - deploy-party
+        deploy:
+          update_config:
+            order: start-first
+            failure_action: rollback
+            delay: 10s
+          rollback_config:
+            parallelism: 0
+            order: stop-first
+          restart_policy:
+            condition: any
+            delay: 5s
+            max_attempts: 3
+            window: 120s
+          labels:
+            - traefik.enable=true
+            - traefik.docker.network=traefik-public
+            - traefik.constraint-label=traefik-public
+            - traefik.http.routers.${container.id}-app-http.rule=Host(\`${container.url}\`) || Host(\`www.${container.url}\`)
+            - traefik.http.routers.${container.id}-app-http.entrypoints=http
+            - traefik.http.routers.${container.id}-app-http.middlewares=https-redirect@swarm
+            - traefik.http.routers.${container.id}-app-https.rule=Host(\`${container.url}\`) || Host(\`www.${container.url}\`)
+            - traefik.http.routers.${container.id}-app-https.entrypoints=https
+            - traefik.http.routers.${container.id}-app-https.tls=true
+            - traefik.http.routers.${container.id}-app-https.tls.certresolver=le
+    ${additionalLabels.join('\n')}
+            - traefik.http.routers.${container.id}-app-https.middlewares=${middlewares.join(',')}
+            - traefik.http.middlewares.${container.id}-redirect.redirectregex.permanent=true
+            - traefik.http.services.${container.id}-app.loadbalancer.server.port=5521
+      `;
+}

projects/app/src/components/ServiceForm.vue

@@ -14,6 +14,7 @@ const props = defineProps<{
 
 const typeOptions = [
   { label: 'Adminer', value: 'ADMINER' },
+  { label: 'CHouse UI', value: 'CHOUSE_UI' },
   { label: 'ClickHouse UI', value: 'CLICKHOUSE_UI' },
   { label: 'Custom', value: 'CUSTOM' },
   { label: 'Directus', value: 'DIRECTUS' },