auto-deploy-sh 2.1.2 → 2.1.4

package/README.md

@@ -80,6 +80,9 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
   - `unless-stopped`(recommended): The container will automatically restart on failure and start after Docker or system restarts.**If the container is manually stopped, it will not be restarted again**, making it suitable for long-running production services.
   - `on-failure`: The container **will restart only if it exits with a non-zero status code**. It will not restart on normal exits (exit code 0).
 - `Options`: **Optional** advanced settings (all sub-properties are optional)
+  - `permission`: Build-time user/group settings. During deployment, they are converted to `docker build --build-arg UID=<uid> --build-arg GID=<gid>`. The Dockerfile must declare and use `ARG UID` and `ARG GID` for these values to take effect.
+    - `uid`: User ID passed as the `UID` build arg.
+    - `gid`: Group ID passed as the `GID` build arg.
   - `volumes`: Volume mappings (array of strings), formatted as `[host-path/volume-name]:[container-path]:[optional-flags]` (e.g., `["/host/data:/container/data:ro"]`).
   - `networks`: Connect the container to a custom Docker network (created via `docker network create <network-name>`) for inter-container communication.
   - `logging`: Docker log management configuration. During deployment, it is converted to Docker `--log-driver` and `--log-opt` arguments. Before starting the container, the tool checks the logging drivers supported by the remote Docker daemon. If the configured `driver` is not supported, deployment stops and prints the current default driver and supported driver list.
@@ -105,6 +108,10 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
   "BindPorts": "string",
   "restart": "'no' | 'always' | 'unless-stopped' | 'on-failure'",
   "Options": {
+    "permission": {
+      "uid": "string",
+      "gid": "string"
+    },
     "volumes": "string[]",
     "networks": "string[]",
     "logging": {
@@ -135,6 +142,10 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
   "BindPorts": "80:80",
   "restart": "unless-stopped",
   "Options": {
+    "permission": {
+      "uid": "1000",
+      "gid": "1000"
+    },
     "volumes": ["/host/logs:/app/logs:rw"],
     "networks": ["my-custom-network", "my-custom-network-1"],
     "logging": {

package/dist/bin/config.js

@@ -71,6 +71,31 @@ const configMethod = {
     },
 };
 const optionsMethod = {
+    permission: {
+        type: 'confirm',
+        message: 'Do you want to set the container user permissions?',
+        default: false,
+        handleFn: async (value) => {
+            if (!value)
+                return {};
+            const gid = await inquirer.invoke({
+                type: 'input',
+                message: 'GID (Group ID): ',
+            });
+            const uid = await inquirer.invoke({
+                type: 'input',
+                message: 'UID (User ID): ',
+            });
+            if (!gid && !uid)
+                return {};
+            const options = {};
+            if (gid)
+                options.gid = gid;
+            if (uid)
+                options.uid = uid;
+            return options;
+        },
+    },
     volumes: {
         type: 'input',
         message: 'Multiple volumes are divided into by , : ',

package/dist/bin/deploy.js

@@ -221,12 +221,18 @@ export class Deploy {
         }
     }
     async buildDocker(ssh, IMAGE_TAG, REMOTEAPPPATH, TARGET_DIR, CONTAINER_NAME) {
+        const options = this.config.Options || {};
+        const gid = options.permission?.gid || '';
+        const uid = options.permission?.uid || '';
+        const buildArgs = [uid ? `--build-arg UID=${uid}` : '', gid ? `--build-arg GID=${gid}` : '']
+            .filter(Boolean)
+            .join(' ');
         await this.execCommand(ssh, {
             startMsg: `🐳 Build image: ${IMAGE_TAG}...`,
             succMsg: `🐳 Build image: ${IMAGE_TAG} success.`,
         }, `
         cd "${REMOTEAPPPATH}"
-        docker build -t ${IMAGE_TAG} ${TARGET_DIR}
+        docker build ${buildArgs} -t ${IMAGE_TAG} ${TARGET_DIR}
       `);
         await this.execCommand(ssh, {
             startMsg: `🔄 Stop and clean the old container.: ${CONTAINER_NAME}...`,

package/dist/bin/index.js

@@ -35,7 +35,7 @@ export async function deploySSH(configFile = 'deploy-config.json') {
         catch {
         }
         finally {
-            fs.removeSync(path.resolve(process.cwd(), deploy.uploadFileName));
+            await fs.remove(path.resolve(process.cwd(), deploy.uploadFileName));
             ssh.dispose();
             exit(1);
         }

package/dist/bin/type/types.d.ts

@@ -12,6 +12,10 @@ export type sshConfig = {
     BindPorts: string;
     restart?: 'no' | 'always' | 'on-failure' | 'unless-stopped';
     Options: {
+        permission?: {
+            gid?: string;
+            uid?: string;
+        };
         volumes: string[];
         networks: string[];
         logging: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-deploy-sh",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "Automated Docker deployment tool",
   "bin": {
     "auto-deploy-sh": "./dist/cli/index.js"