auto-deploy-sh 2.1.3 → 2.1.5

package/README.md

@@ -24,7 +24,7 @@ npm install auto-deploy-sh -D
 }
 ```
 
-2. Execute in terminal:
+- Execute in terminal:
 
 ```bash
 npm run deploy
@@ -79,7 +79,12 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
   - `always`: The container **will always restart automatically** if it stops. It will also start automatically after Docker or system restarts.Even if the container is manually stopped, it will be restarted again after Docker restarts.
   - `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).
+- `afterLaunch` (optional): **Post-start commands** (array of strings) to execute on the remote server after the container starts. Commands run from `/tmp/www/app/<containerName>` and are chained with `&&`, so if one command fails, the following commands are skipped and the deployment is marked as failed (e.g., `["docker ps", "curl -f http://localhost/health"]`).
+- `customRunOptions` (optional): Custom content appended to the end of the `docker run` command after the image tag. It can be used to pass a custom container startup command or arguments (e.g., `"--env-file ./env.list"`).
 - `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.
@@ -104,7 +109,13 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
   "containerName": "string",
   "BindPorts": "string",
   "restart": "'no' | 'always' | 'unless-stopped' | 'on-failure'",
+  "afterLaunch": "string[]",
+  "customRunOptions": "string",
   "Options": {
+    "permission": {
+      "uid": "string",
+      "gid": "string"
+    },
     "volumes": "string[]",
     "networks": "string[]",
     "logging": {
@@ -134,7 +145,13 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
   "containerName": "my-app-container",
   "BindPorts": "80:80",
   "restart": "unless-stopped",
+  "afterLaunch": ["docker ps", "curl -f http://localhost/health"],
+  "customRunOptions": "npm run start:prod",
   "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

@@ -69,8 +69,42 @@ const configMethod = {
             },
         ],
     },
+    afterLaunch: {
+        type: 'input',
+        message: 'After launch (multiple commands separated by , ): ',
+        handleFn: (value) => value.split(','),
+    },
+    customRunOptions: {
+        type: 'input',
+        message: 'Custom run options (optional): eg: --env-file ./env.list',
+    },
 };
 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

@@ -211,6 +211,15 @@ export class Deploy {
       `);
             await this.buildDocker(ssh, IMAGE_TAG, REMOTEAPPPATH, TARGET_DIR, CONTAINER_NAME);
             await this.runDocker(ssh, CONTAINER_NAME);
+            if (this.config.afterLaunch && Array.isArray(this.config.afterLaunch)) {
+                await this.execCommand(ssh, {
+                    startMsg: 'Start executing afterLaunch commands....',
+                    succMsg: 'afterLaunch commands completed.',
+                }, `
+              cd "${REMOTEAPPPATH}/${CONTAINER_NAME}"
+              ${this.config.afterLaunch.join(' && ')}
+          `);
+            }
             log.done('✔ Deployment completed.');
         }
         catch {
@@ -221,12 +230,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}...`,
@@ -309,7 +324,7 @@ export class Deploy {
             startMsg: `🐳 Start container: ${CONTAINER_NAME}...`,
             succMsg: `🐳 Container started successfully.`,
         }, `
-        docker run -d ${optionsCLI}
+        docker run -d ${optionsCLI} ${this.config.customRunOptions || ''}
       `);
     }
     async judgeNetwork(ssh, networks) {

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

@@ -11,7 +11,12 @@ export type sshConfig = {
     containerName: string;
     BindPorts: string;
     restart?: 'no' | 'always' | 'on-failure' | 'unless-stopped';
+    afterLaunch?: string[];
     Options: {
+        permission?: {
+            gid?: string;
+            uid?: string;
+        };
         volumes: string[];
         networks: string[];
         logging: {
@@ -23,6 +28,7 @@ export type sshConfig = {
             };
         };
     };
+    customRunOptions?: string;
 };
 export type fileData = string | NodeJS.ArrayBufferView;
 import type { promises } from 'fs';

package/package.json

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