Merge pull request #78 from P4PER/feat/add-chisel-to-templates

feat: add Chisel app template and SVG icon for service availability

Author: biersoeckli

public/template-icons/chisel.svg

@@ -185,6 +185,7 @@ class AppService {
         // for new objects, make sure some params are optional, wich will be created by prisma
         const optionalParam = z.object({
             id: z.string().optional(),
+            appId: z.string().optional(),
             createdAt: z.date().optional(),
             updatedAt: z.date().optional(),
         });

src/server/services/app.service.ts

@@ -44,6 +44,7 @@ import { openwebuiAppTemplate, postCreateOpenwebuiAppTemplate } from "./apps/ope
 import { AppExtendedModel } from "../model/app-extended.model";
 import { tikaAppTemplate } from "./apps/tika.template";
 import { libredeskAppTemplate, postCreateLibredeskAppTemplate } from "./apps/libredesk.template";
+import { chiselAppTemplate, postCreateChiselAppTemplate } from "./apps/chisel.template";
 
 
 export const databaseTemplates: AppTemplateModel[] = [
@@ -95,7 +96,8 @@ export const appTemplates: AppTemplateModel[] = [
     duplicatiAppTemplate,
     openwebuiAppTemplate,
     tikaAppTemplate,
-    libredeskAppTemplate
+    libredeskAppTemplate,
+    chiselAppTemplate
 ];
 
 export const postCreateTemplateFunctions: Map<string, (createdApps: AppExtendedModel[]) => Promise<AppExtendedModel[]>> = new Map([
@@ -105,6 +107,7 @@ export const postCreateTemplateFunctions: Map<string, (createdApps: AppExtendedM
     [docmostAppTemplate.name, postCreateDocmostAppTemplate],
     [duplicatiAppTemplate.name, postCreateDuplicatiAppTemplate],
     [n8nAppTemplate.name, postCreateN8NAppTemplate],
+    [chiselAppTemplate.name, postCreateChiselAppTemplate],
 ]);
 
 

src/shared/templates/all.templates.ts

@@ -0,0 +1,82 @@
+import { Constants } from "@/shared/utils/constants";
+import { AppTemplateContentModel, AppTemplateModel } from "../../model/app-template.model";
+import { AppExtendedModel } from "@/shared/model/app-extended.model";
+import crypto from "crypto";
+
+export function getChiselAppTemplate(config?: {
+    appName?: string,
+    username?: string,
+    password?: string
+}): AppTemplateContentModel {
+    return {
+        inputSettings: [
+            {
+                key: "containerImageSource",
+                label: "Container Image",
+                value: "jpillora/chisel:latest",
+                isEnvVar: false,
+                randomGeneratedIfEmpty: false,
+            },
+            {
+                key: "CHISEL_USER",
+                label: "Username",
+                value: config?.username || "chisel",
+                isEnvVar: true,
+                randomGeneratedIfEmpty: false,
+            },
+            {
+                key: "CHISEL_PASSWORD",
+                label: "Password",
+                value: config?.password || "",
+                isEnvVar: true,
+                randomGeneratedIfEmpty: true,
+            },
+        ],
+        appModel: {
+            name: config?.appName || "Chisel Tunnel",
+            appType: 'APP',
+            sourceType: 'CONTAINER',
+            containerImageSource: "",
+            replicas: 1,
+            ingressNetworkPolicy: Constants.DEFAULT_INGRESS_NETWORK_POLICY_APPS,
+            egressNetworkPolicy: Constants.DEFAULT_EGRESS_NETWORK_POLICY_APPS,
+            envVars: ``,
+            useNetworkPolicy: true,
+            healthCheckPeriodSeconds: Constants.DEFAULT_HEALTH_CHECK_PERIOD_SECONDS,
+            healthCheckTimeoutSeconds: Constants.DEFAULT_HEALTH_CHECK_TIMEOUT_SECONDS,
+            healthCheckFailureThreshold: Constants.DEFAULT_HEALTH_CHECK_FAILURE_THRESHOLD,
+            containerArgs: '["server", "--keyfile", "/etc/chisel/chisel.key", "--auth", "$(CHISEL_USER):$(CHISEL_PASSWORD)", "--reverse"]',
+        },
+        appDomains: [],
+        appVolumes: [],
+        appFileMounts: [],
+        appPorts: [{
+            port: 8080,
+        }],
+    };
+}
+
+export const chiselAppTemplate: AppTemplateModel = {
+    name: "Chisel Tunnel",
+    iconName: 'chisel.svg',
+    templates: [
+        getChiselAppTemplate()
+    ],
+};
+
+export const postCreateChiselAppTemplate = async (createdApps: AppExtendedModel[]): Promise<AppExtendedModel[]> => {
+    const app = createdApps[0];
+
+    const { privateKey } = crypto.generateKeyPairSync('ec', {
+        namedCurve: 'P-256',
+        privateKeyEncoding: { type: 'sec1', format: 'pem' },
+        publicKeyEncoding: { type: 'spki', format: 'pem' },
+    });
+
+    app.appFileMounts.push({
+        containerMountPath: '/etc/chisel/chisel.key',
+        content: privateKey,
+    } as any);
+
+    return [app];
+};