Merge branch 'master.global.env'

tobi1449 · tobi1449 · commit 502a729aa6b4 · 2025-01-21T17:32:46.000+01:00
diff --git a/backend/agent-socket-handlers/docker-socket-handler.ts b/backend/agent-socket-handlers/docker-socket-handler.ts
@@ -49,7 +49,7 @@ export class DockerSocketHandler extends AgentSocketHandler {
                     await stack.delete(socket);
                 }
 
-                let exitCode = await Terminal.exec(server, socket, terminalName, "git", ["clone", "-b", branch, gitUrl, stackName], server.stacksDir);
+                let exitCode = await Terminal.exec(server, socket, terminalName, "git", [ "clone", "-b", branch, gitUrl, stackName ], server.stacksDir);
                 if (exitCode !== 0) {
                     throw new Error(`Failed to clone git repo [Exit Code ${exitCode}]`);
                 }
diff --git a/backend/socket-handlers/main-socket-handler.ts b/backend/socket-handlers/main-socket-handler.ts
@@ -18,6 +18,8 @@ import {
 import { passwordStrength } from "check-password-strength";
 import jwt from "jsonwebtoken";
 import { Settings } from "../settings";
+import fs, { promises as fsAsync } from "fs";
+import path from "path";
 
 export class MainSocketHandler extends SocketHandler {
     create(socket: DockgeSocket, server: DockgeServer) {
@@ -242,6 +244,12 @@ export class MainSocketHandler extends SocketHandler {
                 checkLogin(socket);
                 const data = await Settings.getSettings("general");
 
+                if (fs.existsSync(path.join(server.stacksDir, "global.env"))) {
+                    data.globalENV = fs.readFileSync(path.join(server.stacksDir, "global.env"), "utf-8");
+                } else {
+                    data.globalENV = "# VARIABLE=value #comment";
+                }
+
                 callback({
                     ok: true,
                     data: data,
@@ -270,6 +278,16 @@ export class MainSocketHandler extends SocketHandler {
                 if (!currentDisabledAuth && data.disableAuth) {
                     await doubleCheckPassword(socket, currentPassword);
                 }
+                // Handle global.env
+                if (data.globalENV && data.globalENV != "# VARIABLE=value #comment") {
+                    await fsAsync.writeFile(path.join(server.stacksDir, "global.env"), data.globalENV);
+                } else {
+                    await fsAsync.rm(path.join(server.stacksDir, "global.env"), {
+                        recursive: true,
+                        force: true
+                    });
+                }
+                delete data.globalENV;
 
                 await Settings.setSettings("general", data);
 
diff --git a/backend/stack.ts b/backend/stack.ts
@@ -101,7 +101,7 @@ export class Stack {
      * Get the status of the stack from `docker compose ps --format json`
      */
     async ps(): Promise<object> {
-        let res = await childProcessAsync.spawn("docker", [ "compose", "ps", "--format", "json" ], {
+        let res = await childProcessAsync.spawn("docker", this.getComposeOptions("ps", "--format", "json"), {
             cwd: this.path,
             encoding: "utf-8",
         });
@@ -117,7 +117,7 @@ export class Stack {
 
     get isGitRepo(): boolean {
         try {
-            execSync("git rev-parse --is-inside-work-tree", {cwd: this.path});
+            execSync("git rev-parse --is-inside-work-tree", { cwd: this.path });
             return true;
         } catch (error) {
             return false;
@@ -127,7 +127,7 @@ export class Stack {
     get gitUrl(): string {
         if (this.isGitRepo) {
             try {
-                let stdout = execSync("git config --get remote.origin.url", {cwd: this.path});
+                let stdout = execSync("git config --get remote.origin.url", { cwd: this.path });
                 return stdout.toString().trim();
             } catch (error) {
                 return "";
@@ -139,7 +139,7 @@ export class Stack {
     get branch(): string {
         if (this.isGitRepo) {
             try {
-                let stdout = execSync("git branch --show-current", {cwd: this.path});
+                let stdout = execSync("git branch --show-current", { cwd: this.path });
                 return stdout.toString().trim();
             } catch (error) {
                 return "";
@@ -258,7 +258,7 @@ export class Stack {
 
     async deploy(socket: DockgeSocket): Promise<number> {
         const terminalName = getComposeTerminalName(socket.endpoint, this.name);
-        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "up", "-d", "--remove-orphans" ], this.path);
+        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("up", "-d", "--remove-orphans"), this.path);
         if (exitCode !== 0) {
             throw new Error("Failed to deploy, please check the terminal output for more information.");
         }
@@ -267,7 +267,7 @@ export class Stack {
 
     async delete(socket: DockgeSocket): Promise<number> {
         const terminalName = getComposeTerminalName(socket.endpoint, this.name);
-        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "down", "--remove-orphans" ], this.path);
+        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("down", "--remove-orphans"), this.path);
         if (exitCode !== 0) {
             throw new Error("Failed to delete, please check the terminal output for more information.");
         }
@@ -481,9 +481,22 @@ export class Stack {
         return stack;
     }
 
+    getComposeOptions(command : string, ...extraOptions : string[]) {
+        //--env-file ./../global.env --env-file .env
+        let options = [ "compose", command, ...extraOptions ];
+        if (fs.existsSync(path.join(this.server.stacksDir, "global.env"))) {
+            if (fs.existsSync(path.join(this.path, ".env"))) {
+                options.splice(1, 0, "--env-file", "./.env");
+            }
+            options.splice(1, 0, "--env-file", "../global.env");
+        }
+        console.log(options);
+        return options;
+    }
+
     async start(socket: DockgeSocket) {
         const terminalName = getComposeTerminalName(socket.endpoint, this.name);
-        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "up", "-d", "--remove-orphans" ], this.path);
+        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("up", "-d", "--remove-orphans"), this.path);
         if (exitCode !== 0) {
             throw new Error("Failed to start, please check the terminal output for more information.");
         }
@@ -492,7 +505,7 @@ export class Stack {
 
     async stop(socket: DockgeSocket): Promise<number> {
         const terminalName = getComposeTerminalName(socket.endpoint, this.name);
-        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "stop" ], this.path);
+        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("stop"), this.path);
         if (exitCode !== 0) {
             throw new Error("Failed to stop, please check the terminal output for more information.");
         }
@@ -501,7 +514,7 @@ export class Stack {
 
     async restart(socket: DockgeSocket): Promise<number> {
         const terminalName = getComposeTerminalName(socket.endpoint, this.name);
-        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "restart" ], this.path);
+        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("restart"), this.path);
         if (exitCode !== 0) {
             throw new Error("Failed to restart, please check the terminal output for more information.");
         }
@@ -510,7 +523,7 @@ export class Stack {
 
     async down(socket: DockgeSocket): Promise<number> {
         const terminalName = getComposeTerminalName(socket.endpoint, this.name);
-        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "down" ], this.path);
+        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("down"), this.path);
         if (exitCode !== 0) {
             throw new Error("Failed to down, please check the terminal output for more information.");
         }
@@ -522,13 +535,13 @@ export class Stack {
 
         if (this.isGitRepo) {
             // TODO: error handling e.g. local changes
-            let exitCode = await Terminal.exec(this.server, socket, terminalName, "git", [ "pull" ], this.path);
+            let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("pull"), this.path);
             if (exitCode !== 0) {
                 throw new Error("Failed to update, please check the terminal output for more information.");
             }
         }
 
-        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "pull" ], this.path);
+        let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("pull"), this.path);
         if (exitCode !== 0) {
             throw new Error("Failed to pull, please check the terminal output for more information.");
         }
@@ -540,7 +553,7 @@ export class Stack {
             return exitCode;
         }
 
-        exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "up", "-d", "--remove-orphans" ], this.path);
+        exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", this.getComposeOptions("up", "-d", "--remove-orphans"), this.path);
         if (exitCode !== 0) {
             throw new Error("Failed to restart, please check the terminal output for more information.");
         }
@@ -597,7 +610,7 @@ export class Stack {
 
     async joinCombinedTerminal(socket: DockgeSocket) {
         const terminalName = getCombinedTerminalName(socket.endpoint, this.name);
-        const terminal = Terminal.getOrCreateTerminal(this.server, terminalName, "docker", [ "compose", "logs", "-f", "--tail", "100" ], this.path);
+        const terminal = Terminal.getOrCreateTerminal(this.server, terminalName, "docker", this.getComposeOptions("logs", "-f", "--tail", "100"), this.path);
         terminal.enableKeepAlive = true;
         terminal.rows = COMBINED_TERMINAL_ROWS;
         terminal.cols = COMBINED_TERMINAL_COLS;
@@ -618,7 +631,7 @@ export class Stack {
         let terminal = Terminal.getTerminal(terminalName);
 
         if (!terminal) {
-            terminal = new InteractiveTerminal(this.server, terminalName, "docker", [ "compose", "exec", serviceName, shell ], this.path);
+            terminal = new InteractiveTerminal(this.server, terminalName, "docker", this.getComposeOptions("exec", serviceName, shell), this.path);
             terminal.rows = TERMINAL_ROWS;
             log.debug("joinContainerTerminal", "Terminal created");
         }
@@ -631,7 +644,7 @@ export class Stack {
         let statusList = new Map<string, Array<object>>();
 
         try {
-            let res = await childProcessAsync.spawn("docker", [ "compose", "ps", "--format", "json" ], {
+            let res = await childProcessAsync.spawn("docker", this.getComposeOptions("ps", "--format", "json"), {
                 cwd: this.path,
                 encoding: "utf-8",
             });
@@ -642,12 +655,15 @@ export class Stack {
 
             let lines = res.stdout?.toString().split("\n");
 
-            const addLine = (obj: { Service: string, State: string, Name: string, Health: string }) => {
+            const addLine = (obj: { Service: string, State: string, Name: string, Health: string, Ports: string }) => {
                 if (!statusList.has(obj.Service)) {
                     statusList.set(obj.Service, []);
                 }
                 statusList.get(obj.Service)?.push({
                     status: obj.Health || obj.State,
+                    ports: obj.Ports.split(/,\s*/).filter((s) => {
+                        return s.indexOf("->") >= 0;
+                    }),
                     name: obj.Name
                 });
             };
diff --git a/common/util-common.ts b/common/util-common.ts
@@ -321,6 +321,7 @@ function copyYAMLCommentsItems(items: any, srcItems: any) {
  *   - "8000-9000:80"
  *   - "127.0.0.1:8001:8001"
  *   - "127.0.0.1:5000-5010:5000-5010"
+ *   - "0.0.0.0:8080->8080/tcp"
  *   - "6060:6060/udp"
  * @param input
  * @param hostname
@@ -330,9 +331,19 @@ export function parseDockerPort(input: string, hostname: string) {
     let display;
 
     const parts = input.split("/");
-    const part1 = parts[0];
+    let part1 = parts[0];
     let protocol = parts[1] || "tcp";
 
+    // coming from docker ps, split host part
+    const arrow = part1.indexOf("->");
+    if (arrow >= 0) {
+        part1 = part1.split("->")[0];
+        const colon = part1.indexOf(":");
+        if (colon >= 0) {
+            part1 = part1.split(":")[1];
+        }
+    }
+
     // Split the last ":"
     const lastColon = part1.lastIndexOf(":");
 
diff --git a/frontend/components.d.ts b/frontend/components.d.ts
@@ -23,6 +23,7 @@ declare module 'vue' {
     DockerStat: typeof import('./src/components/DockerStat.vue')['default']
     General: typeof import('./src/components/settings/General.vue')['default']
     GitOps: typeof import('./src/components/settings/GitOps.vue')['default']
+    GlobalEnv: typeof import('./src/components/settings/GlobalEnv.vue')['default']
     HiddenInput: typeof import('./src/components/HiddenInput.vue')['default']
     Login: typeof import('./src/components/Login.vue')['default']
     NetworkInput: typeof import('./src/components/NetworkInput.vue')['default']
diff --git a/frontend/src/components/settings/GlobalEnv.vue b/frontend/src/components/settings/GlobalEnv.vue
@@ -0,0 +1,109 @@
+<template>
+    <div>
+        <div v-if="settingsLoaded" class="my-4">
+            <form class="my-4" autocomplete="off" @submit.prevent="saveGeneral">
+                <div class="shadow-box mb-3 editor-box edit-mode">
+                    <prism-editor
+                        ref="editor"
+                        v-model="settings.globalENV"
+                        class="env-editor"
+                        :highlight="highlighterENV"
+                        line-numbers
+                    ></prism-editor>
+                </div>
+
+                <div class="my-4">
+                    <!-- Save Button -->
+                    <div>
+                        <button class="btn btn-primary" type="submit">
+                            {{ $t("Save") }}
+                        </button>
+                    </div>
+                </div>
+            </form>
+        </div>
+    </div>
+</template>
+
+<script>
+import { highlight, languages } from "prismjs/components/prism-core";
+import { PrismEditor } from "vue-prism-editor";
+
+let prismjsSymbolDefinition = {
+    "symbol": {
+        pattern: /(?<!\$)\$(\{[^{}]*\}|\w+)/,
+    }
+};
+
+export default {
+    components: {
+        PrismEditor,
+    },
+
+    data() {
+        return {
+        };
+    },
+
+    computed: {
+        settings() {
+            return this.$parent.$parent.$parent.settings;
+        },
+        saveSettings() {
+            return this.$parent.$parent.$parent.saveSettings;
+        },
+        settingsLoaded() {
+            return this.$parent.$parent.$parent.settingsLoaded;
+        }
+    },
+
+    methods: {
+        /** Save the settings */
+        saveGeneral() {
+            this.saveSettings();
+        },
+
+        highlighterENV(code) {
+            if (!languages.docker_env) {
+                languages.docker_env = {
+                    "comment": {
+                        pattern: /(^#| #).*$/m,
+                        greedy: true
+                    },
+                    "keyword": {
+                        pattern: /^\w*(?=[:=])/m,
+                        greedy: true
+                    },
+                    "value": {
+                        pattern: /(?<=[:=]).*?((?= #)|$)/m,
+                        greedy: true,
+                        inside: {
+                            "string": [
+                                {
+                                    pattern: /^ *'.*?(?<!\\)'/m,
+                                },
+                                {
+                                    pattern: /^ *".*?(?<!\\)"|^.*$/m,
+                                    inside: prismjsSymbolDefinition
+                                },
+                            ],
+                        },
+                    },
+                };
+            }
+            return highlight(code, languages.docker_env);
+        },
+    },
+};
+</script>
+
+<style scoped lang="scss">
+
+.editor-box {
+    font-family: 'JetBrains Mono', monospace;
+    font-size: 14px;
+    &.edit-mode {
+        background-color: #2c2f38 !important;
+    }
+}
+</style>
diff --git a/frontend/src/lang/en.json b/frontend/src/lang/en.json
@@ -145,5 +145,6 @@
     "copy": "Copy",
     "GitOps": "GitOps",
     "GitConfig": "Git Configuration",
-    "gitSync": "Sync Repo"
-}
+    "gitSync": "Sync Repo",
+    "GlobalEnv": "Global .env"
+}
diff --git a/frontend/src/pages/Compose.vue b/frontend/src/pages/Compose.vue
diff --git a/frontend/src/pages/Settings.vue b/frontend/src/pages/Settings.vue
diff --git a/frontend/src/router.ts b/frontend/src/router.ts

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export class DockerSocketHandler extends AgentSocketHandler {`
`49`	`49`	`await stack.delete(socket);`
`50`	`50`	`}`
`51`	`51`
`52`		`- let exitCode = await Terminal.exec(server, socket, terminalName, "git", ["clone", "-b", branch, gitUrl, stackName], server.stacksDir);`
	`52`	`+ let exitCode = await Terminal.exec(server, socket, terminalName, "git", [ "clone", "-b", branch, gitUrl, stackName ], server.stacksDir);`
`53`	`53`	`if (exitCode !== 0) {`
`54`	`54`	throw new Error(`Failed to clone git repo [Exit Code ${exitCode}]`);
`55`	`55`	`}`