@drocketxx/pm2me 1.1.0 → 1.1.3

package/README.md

@@ -10,6 +10,48 @@ PM2Me lets you **deploy apps directly from a GitHub repository**, manage PM2 pro
 
 ---
 
+## 🚀 Recommended Installation
+
+The standard way to use PM2Me is to install it globally via npm:
+
+```bash
+# Install globally
+npm install -g @drocketxx/pm2me
+```
+
+---
+
+## 📋 Commands
+
+### Standard Execution
+```bash
+# Run the server in foreground
+pm2me
+
+# Run on a custom port
+pm2me --port 8080
+```
+
+### Background Service (Recommended)
+Manage PM2Me as a system service using these commands:
+
+```bash
+# Install & start as a background service (using PM2)
+pm2me service install
+
+# Uninstall/Remove the service
+pm2me service uninstall
+
+# Control the service
+pm2me service start
+pm2me service stop
+pm2me service restart
+```
+
+> **Note:** The `service install` command will register PM2Me as `pm2me-server` in PM2 and attempt to set up system startup.
+
+---
+
 ## ✨ Features
 
 | Feature | Details |
@@ -45,188 +87,49 @@ PM2Me lets you **deploy apps directly from a GitHub repository**, manage PM2 pro
 
 ---
 
-## 🚀 Getting Started
-
-### Prerequisites
-- [Node.js](https://nodejs.org/) >= 18
-- [PM2](https://pm2.keymetrics.io/) installed globally: `npm install -g pm2`
-- [Git](https://git-scm.com/) installed and accessible in `PATH`
-
-### Installation & Running (Recommended with PM2)
+## 🔐 Setup & Security
 
-```bash
-# 1. Clone the repository
-git clone https://github.com/drocketxx/PM2Me.git
-cd PM2Me
+### First Run
+On your first run, PM2Me will guide you through a **Setup Wizard** to configure your apps storage path and set your admin password.
 
-# 2. Install all dependencies (frontend + backend)
-npm run install:all
-
-# 3. Build the frontend
-npm run build
-
-# 4. Start PM2Me with PM2 ✅ Recommended
-cd backend
-pm2 start app.js --name pm2me
-
-# 5. Auto-start on system reboot
-pm2 save
-pm2 startup
-```
-
-Open your browser at: **http://localhost:12345**
-
-> 💡 **Useful PM2 commands:**
-> ```bash
-> pm2 status          # Check PM2Me status
-> pm2 logs pm2me      # View PM2Me logs
-> pm2 restart pm2me   # Restart PM2Me
-> pm2 stop pm2me      # Stop PM2Me
-> ```
-
-**Development mode** (nodemon auto-restart):
-```bash
-cd /path/to/PM2Me
-npm run dev
-```
-
----
-
-## 🔐 Default Login & Password Management
-
-On first run, **no password is set**. Use the CLI to set one:
-
-```bash
-# Set or change admin password
-npm run pw -- <your_password>
-
-# Example
-npm run pw -- mySecretPass123
-```
-
-> You can also run it directly from the `backend/` folder:
-> ```bash
-> cd backend && node scripts/change-password.js mySecretPass123
-> ```
->
-> The password is stored as a **bcrypt hash** (12 rounds) in `backend/db/database.json`.
-
----
-
-## 🔗 GitHub Webhook Setup
-
-PM2Me supports automatic deployments triggered by `git push`. Here's how to enable it:
+### Data Storage
+- **Database:** Stored in `~/.pm2me/database.json`
+- **Cloned Apps:** Default to `~/.pm2me/apps/` (User configurable)
 
+### GitHub Webhooks
 1. Go to your GitHub repository → **Settings** → **Webhooks** → **Add webhook**
 2. Set **Payload URL** to: `http://your-server-ip:12345/api/webhook`
 3. Set **Content type** to: **`application/json`** ⚠️
-4. Set **Secret** from the Settings page in PM2Me (generate one if needed)
+4. Set **Secret** from the Settings page in PM2Me
 5. Select **Just the push event**
-6. Click **Add webhook**
-
-PM2Me will automatically re-deploy any matching app (matched by repo URL + branch) on each push.
-
-> **Webhook History** (last 50 events) is displayed on the Settings page in real-time.
-
----
-
-## 📂 Project Structure
-
-```
-PM2Me/
-├── backend/
-│   ├── app.js              # Express server + Socket.IO setup
-│   ├── db/
-│   │   ├── index.js        # LowDB initialization
-│   │   └── database.json   # App data, settings, webhook logs
-│   ├── routes/
-│   │   ├── api.js          # Main API routes
-│   │   └── auth.js         # Login / JWT auth
-│   ├── services/
-│   │   ├── gitService.js   # Git clone/pull operations
-│   │   ├── pm2Service.js   # PM2 process management
-│   │   ├── systemService.js# CPU / RAM / Disk / Network stats
-│   │   └── notificationService.js # Discord & Telegram alerts
-│   ├── scripts/
-│   │   └── change-password.js  # CLI tool to change admin password
-│   └── public/             # Built Vue frontend (served statically)
-├── frontend/
-│   ├── src/
-│   │   ├── views/
-│   │   │   ├── Dashboard.vue   # Main app dashboard
-│   │   │   ├── Settings.vue    # Settings & webhook history
-│   │   │   └── Login.vue       # Auth page
-│   │   ├── components/
-│   │   │   ├── DeployModal.vue # New/Edit app deployment modal
-│   │   │   ├── LogViewer.vue   # Real-time log stream
-│   │   │   └── ServerStats.vue # CPU/RAM/Network widget
-│   │   ├── router/             # Vue Router config
-│   │   └── App.vue             # Nav layout
-│   └── vite.config.js
-├── apps/                   # Cloned app repos live here
-└── package.json            # Root scripts (dev, build, pw)
-```
-
----
-
-## 📝 Available Scripts
-
-Run these from the **root** `PM2Me/` directory:
-
-| Command | Description |
-|---|---|
-| `npm run dev` | Build frontend & start backend dev server |
-| `npm run build` | Build frontend only |
-| `npm run pw -- <password>` | Change admin password |
-| `npm run install:all` | Install all dependencies (root + frontend + backend) |
 
 ---
 
-## 📡 API Overview
-
-| Method | Endpoint | Description |
-|---|---|---|
-| `POST` | `/api/auth/login` | Login, returns JWT token |
-| `GET` | `/api/pm2/list` | List all PM2 processes |
-| `POST` | `/api/pm2/:action` | PM2 action: start/stop/restart/delete |
-| `GET` | `/api/apps` | List all deployed apps (DB) |
-| `POST` | `/api/apps` | Register a new app |
-| `PUT` | `/api/apps/:id` | Update app config |
-| `DELETE` | `/api/apps/:id` | Delete app from DB |
-| `POST` | `/api/apps/:id/deploy` | Trigger deployment |
-| `GET` | `/api/apps/:id/sync-status` | Check if branch is behind remote |
-| `GET` | `/api/settings` | Get current settings |
-| `POST` | `/api/settings` | Save settings |
-| `GET` | `/api/settings/webhook-logs` | Get last 50 webhook events |
-| `POST` | `/api/webhook` | GitHub Webhook receiver |
-| `GET` | `/api/system/stats` | Server system stats |
+## 🛠️ Manual Installation (For Developers)
 
----
+If you want to contribute or run from source:
 
-## 📦 Deployment (Production)
+```bash
+# 1. Clone the repository
+git clone https://github.com/drocketxx/PM2Me.git
+cd PM2Me
 
-For production, it's recommended to run the PM2Me backend itself with PM2:
+# 2. Install all dependencies
+npm run install:all
 
-```bash
-# Build the frontend
+# 3. Build the frontend
 npm run build
 
-# Start with PM2
-cd backend
-pm2 start app.js --name pm2me
-
-# Save and set to auto-restart on reboot
-pm2 save
-pm2 startup
+# 4. Start in development mode
+npm run dev
 ```
 
 ---
 
 ## 🛡 Security Notes
 
-- Change the default admin password immediately on first run using `npm run pw`.
-- Set a strong `JWT_SECRET` in your `.env` file.
-- Always set a **Webhook Secret** to prevent unauthorized deploys.
+- Set a strong admin password during the setup wizard.
+- Always use a **Webhook Secret** to prevent unauthorized deployment triggers.
 - Consider putting PM2Me behind a reverse proxy (e.g., Nginx) with HTTPS in production.
 
 ---

package/backend/routes/api.js

@@ -45,7 +45,7 @@ router.get('/pm2/version-check', async (req, res) => {
         // Check globally installed PM2 version via npm (avoids local node_modules/.bin/pm2)
         let installedVersion = null;
         try {
-            const { stdout } = await execAsync('npm list -g pm2 --depth=0 --json');
+            const { stdout } = await execAsync('npm list -g pm2 --depth=0 --json', { windowsHide: true });
             const parsed = JSON.parse(stdout);
             installedVersion = parsed?.dependencies?.pm2?.version || null;
         } catch {
@@ -404,7 +404,7 @@ export const performDeployment = async (appId, io) => {
             await setPipelineState('building');
             logProcess('Executing Build Script', true);
             await new Promise((resolve, reject) => {
-                const child = exec(normalizedScript, { cwd: targetPath, maxBuffer: 10 * 1024 * 1024 });
+                const child = exec(normalizedScript, { cwd: targetPath, maxBuffer: 10 * 1024 * 1024, windowsHide: true });
                 child.stdout.on('data', data => { io.emit(`deploy-log-${appId}`, data.toString()); fs.appendFileSync(logFilePath, data); });
                 child.stderr.on('data', data => { io.emit(`deploy-log-${appId}`, data.toString()); fs.appendFileSync(logFilePath, data); });
                 child.on('close', code => {
@@ -1023,7 +1023,7 @@ router.post('/system/update', async (req, res) => {
             cmd = 'git pull origin main && npm run build';
             cwd = path.resolve(__dirname, '../..');
         }
-        const { stdout, stderr } = await execAsync(cmd, { cwd }).catch(err => ({
+        const { stdout, stderr } = await execAsync(cmd, { cwd, windowsHide: true }).catch(err => ({
             stdout: '', stderr: err.message
         }));
         const output = [stdout, stderr].filter(Boolean).join('\n').trim();

package/backend/services/gitService.js

@@ -28,9 +28,9 @@ export const syncRepo = async (repoUrl, targetPath, branchName, token = null) =>
             fs.rmSync(targetPath, { recursive: true, force: true });
         }
         fs.mkdirSync(targetPath, { recursive: true });
-        const git = simpleGit().env(envOptions);
+        const git = simpleGit({ spawnOptions: { windowsHide: true } }).env(envOptions);
         await git.clone(finalUrl, targetPath, ['--branch', branchName]);
-        const gitLocal = simpleGit(targetPath);
+        const gitLocal = simpleGit(targetPath, { spawnOptions: { windowsHide: true } });
         const log = await gitLocal.log(['-1']);
         const commitHash = log.latest.hash;
         const commitMessage = log.latest.message;
@@ -45,7 +45,7 @@ export const syncRepo = async (repoUrl, targetPath, branchName, token = null) =>
         }
     } else {
         try {
-            const git = simpleGit(targetPath).env(envOptions);
+            const git = simpleGit(targetPath, { spawnOptions: { windowsHide: true } }).env(envOptions);
             await git.remote(['set-url', 'origin', finalUrl]);
             await git.fetch('origin', branchName);
             await git.checkout(branchName);
@@ -68,7 +68,7 @@ export const syncRepo = async (repoUrl, targetPath, branchName, token = null) =>
 
 export const getBranches = async (repoUrl, token = null) => {
     const finalUrl = getFinalUrl(repoUrl, token);
-    const git = simpleGit().env({ ...process.env, GIT_TERMINAL_PROMPT: '0' });
+    const git = simpleGit({ spawnOptions: { windowsHide: true } }).env({ ...process.env, GIT_TERMINAL_PROMPT: '0' });
     const branches = await git.listRemote(['--heads', finalUrl]);
     // Parse branch output, simplistic split
     return branches.split('\n').filter(Boolean).map(line => line.split('refs/heads/')[1]);
@@ -82,7 +82,7 @@ export const getBehindCount = async (repoUrl, targetPath, branchName, token = nu
     if (!isGitRepo) return 0;
 
     const finalUrl = getFinalUrl(repoUrl, token);
-    const git = simpleGit(targetPath).env({ ...process.env, GIT_TERMINAL_PROMPT: '0' });
+    const git = simpleGit(targetPath, { spawnOptions: { windowsHide: true } }).env({ ...process.env, GIT_TERMINAL_PROMPT: '0' });
 
     try {
         await git.remote(['set-url', 'origin', finalUrl]);
@@ -96,7 +96,7 @@ export const getBehindCount = async (repoUrl, targetPath, branchName, token = nu
 };
 
 export const checkout = async (targetPath, ref) => {
-    const git = simpleGit(targetPath).env({ ...process.env, GIT_TERMINAL_PROMPT: '0' });
+    const git = simpleGit(targetPath, { spawnOptions: { windowsHide: true } }).env({ ...process.env, GIT_TERMINAL_PROMPT: '0' });
     try {
         await git.checkout(ref);
         const log = await git.log(['-1']);

package/bin/pm2me.js

@@ -5,6 +5,9 @@
  *   pm2me                      (Run in foreground)
  *   pm2me service install      (Run in background via PM2 + set boot startup)
  *   pm2me service uninstall    (Remove from PM2 background)
+ *   pm2me service start        (Start background service)
+ *   pm2me service stop         (Stop background service)
+ *   pm2me service restart      (Restart background service)
  */
 import path from 'path';
 import { fileURLToPath } from 'url';
@@ -22,32 +25,38 @@ const args = process.argv.slice(2);
 // ── Handle Service Commands ───────────────────────────────────────────────────
 if (args[0] === 'service') {
     const action = args[1];
+    const SERVICE_NAME = 'pm2me-server';
+
     if (action === 'install') {
         console.log('[pm2me] Installing background service...');
         try {
-            // 1. Start pm2me via PM2
-            // We use the full path to the backend app.js
+            const isWindows = os.platform() === 'win32';
             const appPath = path.join(backendDir, 'app.js');
             const homeDir = path.join(os.homedir(), '.pm2me');
             const dbPath = path.join(homeDir, 'database.json');
 
-            console.log(`[pm2me] Starting via PM2 as 'pm2me-server'...`);
-            execSync(`pm2 start "${appPath}" --name pm2me-server --env PM2ME_DB_PATH="${dbPath}"`, { stdio: 'inherit' });
+            console.log(`[pm2me] Starting via PM2 as '${SERVICE_NAME}'...`);
+            execSync(`pm2 start "${appPath}" --name ${SERVICE_NAME} --env PM2ME_DB_PATH="${dbPath}"`, { stdio: 'inherit', windowsHide: true });
 
-            // 2. Save PM2 list
             console.log(`[pm2me] Saving PM2 process list...`);
-            execSync(`pm2 save`, { stdio: 'inherit' });
-
-            // 3. Optional: Startup (User needs to run this with sudo/admin usually, but we try)
-            console.log(`[pm2me] Setting up boot startup...`);
-            try {
-                execSync(`pm2 startup`, { stdio: 'inherit' });
-                console.log(`[pm2me] Done! If you see a command above, please copy and run it to finalize startup.`);
-            } catch (e) {
-                console.log(`[pm2me] 'pm2 startup' might need manual execution. Check instructions above.`);
+            execSync(`pm2 save`, { stdio: 'inherit', windowsHide: true });
+
+            if (isWindows) {
+                console.log(`\n[pm2me] 💡 Windows Info: '${SERVICE_NAME}' is now running in the background.`);
+                console.log(`[pm2me] To make it start automatically on Windows restart, we recommend using 'pm2-windows-startup':`);
+                console.log(`        npm install -g pm2-windows-startup`);
+                console.log(`        pm2-startup install`);
+            } else {
+                console.log(`[pm2me] Setting up boot startup...`);
+                try {
+                    execSync(`pm2 startup`, { stdio: 'inherit', windowsHide: true });
+                    console.log(`[pm2me] Done! If you see a command above, please copy and run it to finalize startup.`);
+                } catch (e) {
+                    console.log(`[pm2me] 'pm2 startup' might need manual execution. Check instructions above.`);
+                }
             }
 
-            console.log(`[pm2me] Service installed successfully. Access your UI at http://localhost:12345`);
+            console.log(`\n[pm2me] Service installed successfully. Access your UI at http://localhost:12345`);
             process.exit(0);
         } catch (err) {
             console.error(`[pm2me] Failed to install service:`, err.message);
@@ -56,16 +65,43 @@ if (args[0] === 'service') {
     } else if (action === 'uninstall') {
         console.log('[pm2me] Uninstalling background service...');
         try {
-            execSync(`pm2 delete pm2me-server`, { stdio: 'inherit' });
-            execSync(`pm2 save`, { stdio: 'inherit' });
+            execSync(`pm2 delete ${SERVICE_NAME}`, { stdio: 'inherit', windowsHide: true });
+            execSync(`pm2 save`, { stdio: 'inherit', windowsHide: true });
             console.log(`[pm2me] Service uninstalled successfully.`);
             process.exit(0);
         } catch (err) {
             console.error(`[pm2me] Failed to uninstall service:`, err.message);
             process.exit(1);
         }
+    } else if (action === 'start') {
+        console.log(`[pm2me] Starting service '${SERVICE_NAME}'...`);
+        try {
+            execSync(`pm2 start ${SERVICE_NAME}`, { stdio: 'inherit', windowsHide: true });
+            process.exit(0);
+        } catch (err) {
+            console.error(`[pm2me] Failed to start service:`, err.message);
+            process.exit(1);
+        }
+    } else if (action === 'stop') {
+        console.log(`[pm2me] Stopping service '${SERVICE_NAME}'...`);
+        try {
+            execSync(`pm2 stop ${SERVICE_NAME}`, { stdio: 'inherit', windowsHide: true });
+            process.exit(0);
+        } catch (err) {
+            console.error(`[pm2me] Failed to stop service:`, err.message);
+            process.exit(1);
+        }
+    } else if (action === 'restart') {
+        console.log(`[pm2me] Restarting service '${SERVICE_NAME}'...`);
+        try {
+            execSync(`pm2 restart ${SERVICE_NAME}`, { stdio: 'inherit', windowsHide: true });
+            process.exit(0);
+        } catch (err) {
+            console.error(`[pm2me] Failed to restart service:`, err.message);
+            process.exit(1);
+        }
     } else {
-        console.log(`Usage: pm2me service [install|uninstall]`);
+        console.log(`Usage: pm2me service [install|uninstall|start|stop|restart]`);
         process.exit(1);
     }
 }
@@ -109,6 +145,7 @@ console.log(`[pm2me] Using database: ${dbPath}`);
 const server = spawn('node', ['app.js'], {
     cwd: backendDir,
     stdio: 'inherit',
+    windowsHide: true,
     env: {
         ...process.env,
         PORT: String(PORT),

package/package.json

@@ -1,59 +1,59 @@
-{
-  "name": "@drocketxx/pm2me",
-  "version": "1.1.0",
-  "description": "PM2 Deployment and Management System — Web UI for PM2 process management",
-  "type": "module",
-  "main": "backend/app.js",
-  "bin": {
-    "pm2me": "./bin/pm2me.js"
-  },
-  "files": [
-    "bin/",
-    "backend/",
-    "README.md"
-  ],
-  "dependencies": {
-    "bcrypt": "^6.0.0",
-    "connect-history-api-fallback": "^2.0.0",
-    "cors": "^2.8.6",
-    "dotenv": "^17.3.1",
-    "express": "^5.2.1",
-    "jsonwebtoken": "^9.0.3",
-    "lowdb": "^7.0.1",
-    "morgan": "^1.10.1",
-    "pm2": "^6.0.14",
-    "simple-git": "^3.32.3",
-    "socket.io": "^4.8.3"
-  },
-  "engines": {
-    "node": ">=18"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/drocketxx/PM2Me.git"
-  },
-  "homepage": "https://github.com/drocketxx/PM2Me",
-  "keywords": [
-    "pm2",
-    "deploy",
-    "management",
-    "nginx",
-    "web-ui"
-  ],
-  "author": "drocketxx",
-  "license": "ISC",
-  "scripts": {
-    "dev:frontend": "cd frontend && npm run dev",
-    "dev:backend": "cd backend && npm run dev",
-    "dev:concurrent": "concurrently \"npm run dev:backend\" \"npm run dev:frontend\"",
-    "build": "cd frontend && npm run build",
-    "dev": "npm run build && cd backend && npm run dev",
-    "install:all": "npm install && cd frontend && npm install && cd ../backend && npm install",
-    "pw": "cd backend && node scripts/change-password.js",
-    "start": "node bin/pm2me.js"
-  },
-  "devDependencies": {
-    "concurrently": "^8.2.2",
-    "nodemon": "^3.1.14"
-  }
+{
+  "name": "@drocketxx/pm2me",
+  "version": "1.1.3",
+  "description": "PM2 Deployment and Management System — Web UI for PM2 process management",
+  "type": "module",
+  "main": "backend/app.js",
+  "bin": {
+    "pm2me": "./bin/pm2me.js"
+  },
+  "files": [
+    "bin/",
+    "backend/",
+    "README.md"
+  ],
+  "dependencies": {
+    "bcrypt": "^6.0.0",
+    "connect-history-api-fallback": "^2.0.0",
+    "cors": "^2.8.6",
+    "dotenv": "^17.3.1",
+    "express": "^5.2.1",
+    "jsonwebtoken": "^9.0.3",
+    "lowdb": "^7.0.1",
+    "morgan": "^1.10.1",
+    "pm2": "^6.0.14",
+    "simple-git": "^3.32.3",
+    "socket.io": "^4.8.3"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/drocketxx/PM2Me.git"
+  },
+  "homepage": "https://github.com/drocketxx/PM2Me",
+  "keywords": [
+    "pm2",
+    "deploy",
+    "management",
+    "nginx",
+    "web-ui"
+  ],
+  "author": "drocketxx",
+  "license": "ISC",
+  "scripts": {
+    "dev:frontend": "cd frontend && npm run dev",
+    "dev:backend": "cd backend && npm run dev",
+    "dev:concurrent": "concurrently \"npm run dev:backend\" \"npm run dev:frontend\"",
+    "build": "cd frontend && npm run build",
+    "dev": "npm run build && cd backend && npm run dev",
+    "install:all": "npm install && cd frontend && npm install && cd ../backend && npm install",
+    "pw": "cd backend && node scripts/change-password.js",
+    "start": "node bin/pm2me.js"
+  },
+  "devDependencies": {
+    "concurrently": "^8.2.2",
+    "nodemon": "^3.1.14"
+  }
 }