Fix check-version.ts

Correct spelling errors.

README.md

@@ -131,7 +131,7 @@ Be sure to read the [guide](https://github.com/louislam/dockge/blob/master/CONTR
 
 #### "Dockge"?
 
-"Dockge" is a coinage word which is created by myself. I hope it sounds like `Dodge`.
+"Dockge" is a coinage word which is created by myself. I originally hoped it sounds like `Dodge`, but apparently many people called it `Dockage`, it is also acceptable.
 
 The naming idea came from Twitch emotes like `sadge`, `bedge` or `wokege`. They all end in `-ge`.
 
@@ -148,13 +148,13 @@ Yes, you can. However, you need to move your compose file into the stacks direct
 3. In Dockge, click the " Scan Stacks Folder" button in the top-right corner's dropdown menu
 4. Now you should see your stack in the list
 
-#### Is Dockge a Portainer replcement?
+#### Is Dockge a Portainer replacement?
 
 Yes or no. Portainer provides a lot of Docker features. While Dockge is currently only focusing on docker-compose with a better user interface and better user experience.
 
 If you want to manage your container with docker-compose only, the answer may be yes.
 
-If you still need to manage something like docker networks, signle containers, the answer may be no.
+If you still need to manage something like docker networks, single containers, the answer may be no.
 
 #### Can I install both Dockge and Portainer?
 

backend/check-version.ts

@@ -3,69 +3,55 @@ import compareVersions from "compare-versions";
 import packageJSON from "../package.json";
 import { Settings } from "./settings";
 
-export const obj = {
-    version: packageJSON.version,
-    latestVersion: null,
-};
-export default obj;
-
 // How much time in ms to wait between update checks
 const UPDATE_CHECKER_INTERVAL_MS = 1000 * 60 * 60 * 48;
 const CHECK_URL = "https://dockge.kuma.pet/version";
 
-let interval : NodeJS.Timeout;
+class CheckVersion {
+    version = packageJSON.version;
+    latestVersion? : string;
+    interval? : NodeJS.Timeout;
 
-export function startInterval() {
-    const check = async () => {
-        if (await Settings.get("checkUpdate") === false) {
-            return;
-        }
-
-        log.debug("update-checker", "Retrieving latest versions");
-
-        try {
-            const res = await fetch(CHECK_URL);
-            const data = await res.json();
-
-            // For debug
-            if (process.env.TEST_CHECK_VERSION === "1") {
-                data.slow = "1000.0.0";
+    async startInterval() {
+        const check = async () => {
+            if (await Settings.get("checkUpdate") === false) {
+                return;
             }
 
-            const checkBeta = await Settings.get("checkBeta");
+            log.debug("update-checker", "Retrieving latest versions");
 
-            if (checkBeta && data.beta) {
-                if (compareVersions.compare(data.beta, data.slow, ">")) {
-                    obj.latestVersion = data.beta;
-                    return;
+            try {
+                const res = await fetch(CHECK_URL);
+                const data = await res.json();
+
+                // For debug
+                if (process.env.TEST_CHECK_VERSION === "1") {
+                    data.slow = "1000.0.0";
                 }
+
+                const checkBeta = await Settings.get("checkBeta");
+
+                if (checkBeta && data.beta) {
+                    if (compareVersions.compare(data.beta, data.slow, ">")) {
+                        this.latestVersion = data.beta;
+                        return;
+                    }
+                }
+
+                if (data.slow) {
+                    this.latestVersion = data.slow;
+                }
+
+            } catch (_) {
+                log.info("update-checker", "Failed to check for new versions");
             }
 
-            if (data.slow) {
-                obj.latestVersion = data.slow;
-            }
+        };
 
-        } catch (_) {
-            log.info("update-checker", "Failed to check for new versions");
-        }
-
-    };
-
-    check();
-    interval = setInterval(check, UPDATE_CHECKER_INTERVAL_MS);
-}
-
-/**
- * Enable the check update feature
- * @param value Should the check update feature be enabled?
- * @returns
- */
-export async function enableCheckUpdate(value : boolean) {
-    await Settings.set("checkUpdate", value);
-
-    clearInterval(interval);
-
-    if (value) {
-        startInterval();
+        await check();
+        this.interval = setInterval(check, UPDATE_CHECKER_INTERVAL_MS);
     }
 }
+
+const checkVersion = new CheckVersion();
+export default checkVersion;

backend/dockge-server.ts

@@ -32,6 +32,8 @@ import User from "./models/user";
 import childProcessAsync from "promisify-child-process";
 import { Terminal } from "./terminal";
 
+import "dotenv/config";
+
 export class DockgeServer {
     app : Express;
     httpServer : http.Server;
@@ -306,6 +308,7 @@ export class DockgeServer {
                 this.sendStackList(true);
             });
 
+            checkVersion.startInterval();
         });
 
         gracefulShutdown(this.httpServer, {

backend/socket-handlers/docker-socket-handler.ts

@@ -12,7 +12,7 @@ export class DockerSocketHandler extends SocketHandler {
         socket.on("deployStack", async (name : unknown, composeYAML : unknown, composeENV : unknown, isAdd : unknown, callback) => {
             try {
                 checkLogin(socket);
-                const stack = this.saveStack(socket, server, name, composeYAML, composeENV, isAdd);
+                const stack = await this.saveStack(socket, server, name, composeYAML, composeENV, isAdd);
                 await stack.deploy(socket);
                 server.sendStackList();
                 callback({
@@ -234,7 +234,7 @@ export class DockerSocketHandler extends SocketHandler {
         socket.on("getDockerNetworkList", async (callback) => {
             try {
                 checkLogin(socket);
-                const dockerNetworkList = server.getDockerNetworkList();
+                const dockerNetworkList = await server.getDockerNetworkList();
                 callback({
                     ok: true,
                     dockerNetworkList,
@@ -264,7 +264,7 @@ export class DockerSocketHandler extends SocketHandler {
         });
     }
 
-    saveStack(socket : DockgeSocket, server : DockgeServer, name : unknown, composeYAML : unknown, composeENV : unknown, isAdd : unknown) : Stack {
+    async saveStack(socket : DockgeSocket, server : DockgeServer, name : unknown, composeYAML : unknown, composeENV : unknown, isAdd : unknown) : Promise<Stack> {
         // Check types
         if (typeof(name) !== "string") {
             throw new ValidationError("Name must be a string");
@@ -280,7 +280,7 @@ export class DockerSocketHandler extends SocketHandler {
         }
 
         const stack = new Stack(server, name, composeYAML, composeENV, false);
-        stack.save(isAdd);
+        await stack.save(isAdd);
         return stack;
     }
 

backend/stack.ts

@@ -1,8 +1,8 @@
 import { DockgeServer } from "./dockge-server";
-import fs from "fs";
+import fs, { promises as fsAsync } from "fs";
 import { log } from "./log";
 import yaml from "yaml";
-import { DockgeSocket, ValidationError } from "./util-server";
+import { DockgeSocket, fileExists, ValidationError } from "./util-server";
 import path from "path";
 import {
     COMBINED_TERMINAL_COLS,
@@ -99,6 +99,15 @@ export class Stack {
 
         // Check YAML format
         yaml.parse(this.composeYAML);
+
+        let lines = this.composeENV.split("\n");
+
+        // Check if the .env is able to pass docker-compose
+        // Prevent "setenv: The parameter is incorrect"
+        // It only happens when there is one line and it doesn't contain "="
+        if (lines.length === 1 && !lines[0].includes("=") && lines[0].length > 0) {
+            throw new ValidationError("Invalid .env format");
+        }
     }
 
     get composeYAML() : string {
@@ -146,29 +155,35 @@ export class Stack {
      * Save the stack to the disk
      * @param isAdd
      */
-    save(isAdd : boolean) {
+    async save(isAdd : boolean) {
         this.validate();
 
         let dir = this.path;
 
         // Check if the name is used if isAdd
         if (isAdd) {
-            if (fs.existsSync(dir)) {
+            if (await fileExists(dir)) {
                 throw new ValidationError("Stack name already exists");
             }
 
             // Create the stack folder
-            fs.mkdirSync(dir);
+            await fsAsync.mkdir(dir);
         } else {
-            if (!fs.existsSync(dir)) {
+            if (!await fileExists(dir)) {
                 throw new ValidationError("Stack not found");
             }
         }
 
         // Write or overwrite the compose.yaml
-        fs.writeFileSync(path.join(dir, this._composeFileName), this.composeYAML);
+        await fsAsync.writeFile(path.join(dir, this._composeFileName), this.composeYAML);
+
+        const envPath = path.join(dir, ".env");
+
         // Write or overwrite the .env
-        fs.writeFileSync(path.join(dir, ".env"), this.composeENV);
+        // If .env is not existing and the composeENV is empty, we don't need to write it
+        if (await fileExists(envPath) || this.composeENV.trim() !== "") {
+            await fsAsync.writeFile(envPath, this.composeENV);
+        }
     }
 
     async deploy(socket? : DockgeSocket) : Promise<number> {
@@ -188,7 +203,7 @@ export class Stack {
         }
 
         // Remove the stack folder
-        fs.rmSync(this.path, {
+        await fsAsync.rm(this.path, {
             recursive: true,
             force: true
         });
@@ -218,12 +233,12 @@ export class Stack {
             stackList = new Map<string, Stack>();
 
             // Scan the stacks directory, and get the stack list
-            let filenameList = fs.readdirSync(stacksDir);
+            let filenameList = await fsAsync.readdir(stacksDir);
 
             for (let filename of filenameList) {
                 try {
                     // Check if it is a directory
-                    let stat = fs.statSync(path.join(stacksDir, filename));
+                    let stat = await fsAsync.stat(path.join(stacksDir, filename));
                     if (!stat.isDirectory()) {
                         continue;
                     }
@@ -282,7 +297,12 @@ export class Stack {
         let res = await childProcessAsync.spawn("docker", [ "compose", "ls", "--all", "--format", "json" ], {
             encoding: "utf-8",
         });
-        let composeList = JSON.parse(res.toString());
+
+        if (!res.stdout) {
+            return statusList;
+        }
+
+        let composeList = JSON.parse(res.stdout.toString());
 
         for (let composeStack of composeList) {
             statusList.set(composeStack.Name, this.statusConvert(composeStack.Status));
@@ -314,7 +334,7 @@ export class Stack {
         let dir = path.join(server.stacksDir, stackName);
 
         if (!skipFSOperations) {
-            if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) {
+            if (!await fileExists(dir) || !(await fsAsync.stat(dir)).isDirectory()) {
                 // Maybe it is a stack managed by docker compose directly
                 let stackList = await this.getStackList(server, true);
                 let stack = stackList.get(stackName);

backend/util-server.ts

@@ -5,6 +5,7 @@ import { log } from "./log";
 import { ERROR_TYPE_VALIDATION } from "./util-common";
 import { R } from "redbean-node";
 import { verifyPassword } from "./password-hash";
+import fs from "fs";
 
 export interface JWTDecoded {
     username : string;
@@ -82,3 +83,9 @@ export async function doubleCheckPassword(socket : DockgeSocket, currentPassword
 
     return user;
 }
+
+export function fileExists(file : string) {
+    return fs.promises.access(file, fs.constants.F_OK)
+        .then(() => true)
+        .catch(() => false);
+}

frontend/src/i18n.ts

@@ -39,7 +39,7 @@ for (let lang in languageList) {
     };
 }
 
-const rtlLangs = [ "fa", "ar-SY", "ur" ];
+const rtlLangs = [ "fa", "ar-SY", "ur", "ar" ];
 
 export const currentLocale = () => localStorage.locale
     || languageList[navigator.language] && navigator.language

frontend/src/lang/en.json

@@ -98,5 +98,6 @@
     "reconnecting...": "Reconnecting…",
     "connecting...": "Connecting to the socket server…",
     "url": "URL | URLs",
-    "extra": "Extra"
+    "extra": "Extra",
+    "newUpdate": "New Update"
 }

frontend/src/lang/it-IT.json

@@ -12,7 +12,7 @@
     "registry": "Registro",
     "compose": "Compose",
     "addFirstStackMsg": "Componi il tuo primo stack!",
-    "stackName" : "Nome dello stack",
+    "stackName": "Nome dello stack",
     "deployStack": "Deploy",
     "deleteStack": "Cancella",
     "stopStack": "Stop",
@@ -23,7 +23,7 @@
     "editStack": "Modifica",
     "discardStack": "Annulla",
     "saveStackDraft": "Salva",
-    "notAvailableShort" : "N/D",
+    "notAvailableShort": "N/D",
     "deleteStackMsg": "Sei sicuro di voler eliminare questo stack?",
     "stackNotManagedByDockgeMsg": "Questo stack non è gestito da Dockge.",
     "primaryHostname": "Hostname primario",
@@ -91,5 +91,11 @@
     "Allowed commands:": "Comandi permessi:",
     "Internal Networks": "Reti interne",
     "External Networks": "Reti esterne",
-    "No External Networks": "Nessuna rete esterna"
+    "No External Networks": "Nessuna rete esterna",
+    "reverseProxyMsg1": "Utilizzando un proxy inverso?",
+    "reverseProxyMsg2": "Controlla come configurarlo per WebSocket",
+    "Cannot connect to the socket server.": "Impossibile connettersi al server socket.",
+    "connecting...": "Connessione al server socket…",
+    "extra": "Extra",
+    "reconnecting...": "Riconnessione…"
 }

frontend/src/lang/ja.json

@@ -17,7 +17,7 @@
     "editStack": "編集",
     "discardStack": "破棄",
     "saveStackDraft": "保存",
-    "stackNotManagedByDockgeMsg": "このスタックはDockageによって管理されていません。",
+    "stackNotManagedByDockgeMsg": "このスタックはDockgeによって管理されていません。",
     "general": "一般",
     "scanFolder": "スタックフォルダをスキャン",
     "dockerImage": "イメージ",

frontend/src/lang/ko-KR.json

@@ -90,5 +90,13 @@
     "Allowed commands:": "허용된 명령어:",
     "Internal Networks": "내부 네트워크",
     "External Networks": "외부 네트워크",
-    "No External Networks": "외부 네트워크 없음"
+    "No External Networks": "외부 네트워크 없음",
+    "reverseProxyMsg2": "여기서 WebSocket을 위한 설정을 확인해 보세요",
+    "downStack": "정지 & Down",
+    "reverseProxyMsg1": "리버스 프록시를 사용하고 계신가요?",
+    "Cannot connect to the socket server.": "소켓 서버에 연결하지 못했습니다.",
+    "connecting...": "소켓 서버에 연결하는 중…",
+    "extra": "기타",
+    "url": "URL | URL",
+    "reconnecting...": "재연결 중…"
 }

frontend/src/layouts/Layout.vue

@@ -16,8 +16,8 @@
                 <span class="fs-4 title">Dockge</span>
             </router-link>
 
-            <a v-if="hasNewVersion" target="_blank" href="https://github.com/louislam/dockge/releases" class="btn btn-info me-3">
-                <font-awesome-icon icon="arrow-alt-circle-up" /> {{ $t("New Update") }}
+            <a v-if="hasNewVersion" target="_blank" href="https://github.com/louislam/dockge/releases" class="btn btn-warning me-3">
+                <font-awesome-icon icon="arrow-alt-circle-up" /> {{ $t("newUpdate") }}
             </a>
 
             <ul class="nav nav-pills">

frontend/src/pages/Compose.vue

@@ -622,7 +622,7 @@ export default {
                         greedy: true
                     },
                     "keyword": {
-                        pattern: /^[^ :=]*(?=[:=])/m,
+                        pattern: /^\w*(?=[:=])/m,
                         greedy: true
                     },
                     "value": {

package.json

@@ -1,6 +1,6 @@
 {
     "name": "dockge",
-    "version": "1.2.0",
+    "version": "1.3.2",
     "type": "module",
     "engines": {
         "node": ">= 18.0.0 && <= 18.17.1"
@@ -33,6 +33,7 @@
         "composerize": "~1.4.1",
         "croner": "~7.0.5",
         "dayjs": "~1.11.10",
+        "dotenv": "~16.3.1",
         "express": "~4.18.2",
         "express-static-gzip": "~2.1.7",
         "http-graceful-shutdown": "~3.1.13",

pnpm-lock.yaml

@@ -32,6 +32,9 @@ dependencies:
   dayjs:
     specifier: ~1.11.10
     version: 1.11.10
+  dotenv:
+    specifier: ~16.3.1
+    version: 16.3.1
   express:
     specifier: ~4.18.2
     version: 4.18.2
@@ -2154,6 +2157,11 @@ packages:
       esutils: 2.0.3
     dev: true
 
+  /dotenv@16.3.1:
+    resolution: {integrity: sha512-IPzF4w4/Rd94bA9imS68tZBaYyBWSCE47V1RGuMrB94iyTOIEwRmVL2x/4An+6mETpLrKJ5hQkB8W4kFAadeIQ==}
+    engines: {node: '>=12'}
+    dev: false
+
   /eastasianwidth@0.2.0:
     resolution: {integrity: sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==}
     dev: false