ezpm2gui 1.0.0

package/ .npmignore

@@ -0,0 +1,39 @@
+# Development files
+src/
+.git/
+.github/
+.gitignore
+.editorconfig
+.eslintrc
+.prettierrc
+tsconfig.json
+nodemon.json
+
+# Tests
+__tests__/
+coverage/
+.nyc_output/
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Cache and temp files
+.cache/
+.temp/
+.tmp/
+*.tmp
+*.temp
+
+# IDE specific files
+.idea/
+.vscode/
+*.swp
+*.swo
+.DS_Store
+
+# Include dist directory when publishing
+!dist/

package/README.md

@@ -0,0 +1,102 @@
+# ezPM2GUI
+
+A modern web-based graphical user interface for the PM2 process manager.
+
+![ezPM2GUI Screenshot](https://via.placeholder.com/800x450.png?text=ezPM2GUI+Screenshot)
+
+## Features
+
+- Real-time process monitoring
+- Process management (start, stop, restart, delete)
+- Detailed process information and logs
+- System metrics dashboard
+- WebSocket for live updates
+- Process CPU and memory charts
+- Filter processes by status or name
+- Responsive design for desktop and mobile
+
+## Installation
+
+### Global Installation
+
+```bash
+npm install -g ezpm2gui
+```
+
+### Local Installation
+
+```bash
+npm install ezpm2gui
+```
+
+## Usage
+
+### As a Command Line Tool (Global Installation)
+
+```bash
+# Start the ezPM2GUI web interface
+ezpm2gui
+
+# Generate a sample PM2 ecosystem config
+ezpm2gui-generate-ecosystem
+```
+
+### As a Module (Local Installation)
+
+```javascript
+const ezpm2gui = require('ezpm2gui');
+
+// Start the server with default options
+ezpm2gui.start();
+
+// Or with custom options
+ezpm2gui.start({
+  port: 3030,
+  host: '0.0.0.0'
+});
+```
+
+### Access the UI
+
+Once started, open your browser and navigate to:
+
+```
+http://localhost:3001
+```
+
+## Requirements
+
+- Node.js 14.x or later
+- PM2 installed globally (`npm install -g pm2`)
+
+## Configuration
+
+ezPM2GUI uses environment variables for configuration:
+
+- `PORT`: The port to run the server on (default: 3001)
+- `HOST`: The host to bind to (default: localhost)
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md) for detailed development instructions.
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/ezpm2gui.git
+cd ezpm2gui
+
+# Install dependencies and build
+./install.sh   # On Linux/macOS
+install.bat    # On Windows
+
+# Start the application
+npm start
+```
+
+## License
+
+ISC
+
+## Credits
+
+Built with ❤️ as a modern alternative to pm2-gui

package/bin/ezpm2gui.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+
+// Determine the path to the server executable
+const serverPath = path.join(__dirname, '../dist/server/index.js');
+
+// Check if the server file exists
+if (!fs.existsSync(serverPath)) {
+  console.error('Error: Server executable not found. Please make sure the package is built correctly.');
+  process.exit(1);
+}
+
+// Start the server
+const server = spawn('node', [serverPath], { stdio: 'inherit' });
+
+// Log startup message
+console.log('\x1b[36m%s\x1b[0m', `
+╔════════════════════════════════════╗
+║          ezPM2GUI Started          ║
+╚════════════════════════════════════╝
+
+Web interface available at: \x1b[1mhttp://localhost:3001\x1b[0m
+
+Press Ctrl+C to stop the server.
+`);
+
+// Handle server process events
+server.on('error', (err) => {
+  console.error('Failed to start server:', err);
+  process.exit(1);
+});
+
+server.on('exit', (code) => {
+  if (code !== 0) {
+    console.error(`Server exited with code ${code}`);
+  }
+  process.exit(code);
+});
+
+// Handle process signals for graceful shutdown
+process.on('SIGINT', () => {
+  console.log('Shutting down ezPM2GUI...');
+  server.kill('SIGINT');
+});
+
+process.on('SIGTERM', () => {
+  console.log('Shutting down ezPM2GUI...');
+  server.kill('SIGTERM');
+});

package/bin/generate-ecosystem.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const ecosystemConfig = `
+module.exports = {
+  apps : [
+    {
+      name: "my-api",
+      script: "./api/index.js",
+      instances: 2,
+      exec_mode: "cluster",
+      watch: false,
+      env: {
+        NODE_ENV: "production",
+        PORT: 3000
+      }
+    },
+    {
+      name: "worker",
+      script: "./workers/queue-processor.js",
+      instances: 1,
+      watch: false,
+      env: {
+        NODE_ENV: "production"
+      }
+    },
+    {
+      name: "cron-job",
+      script: "./cron/scheduler.js",
+      instances: 1,
+      watch: false,
+      cron_restart: "0 0 * * *",
+      env: {
+        NODE_ENV: "production"
+      }
+    }
+  ]
+}
+`;
+
+// Get the output path
+const outputPath = process.argv[2] || 'ecosystem.config.js';
+const fullPath = path.resolve(process.cwd(), outputPath);
+
+try {
+  // Write file
+  fs.writeFileSync(fullPath, ecosystemConfig);
+  console.log(`PM2 ecosystem file generated at: ${fullPath}`);
+  console.log('\nTo start your PM2 processes with this configuration:');
+  console.log('  pm2 start ecosystem.config.js');
+  console.log('\nTo monitor your processes with ezPM2GUI:');
+  console.log('  ezpm2gui');
+} catch (error) {
+  console.error('Error generating ecosystem file:', error);
+}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+interface StartOptions {
+    port?: number;
+    host?: string;
+}
+/**
+ * Start the ezPM2GUI server
+ * @param options Configuration options
+ * @returns The HTTP server instance
+ */
+export declare function start(options?: StartOptions): import("http").Server<typeof import("http").IncomingMessage, typeof import("http").ServerResponse>;
+declare const _default: {
+    start: typeof start;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.start = start;
+// src/index.ts - Main entry point for programmatic usage
+const index_1 = require("./server/index");
+/**
+ * Start the ezPM2GUI server
+ * @param options Configuration options
+ * @returns The HTTP server instance
+ */
+function start(options = {}) {
+    const port = options.port || process.env.PORT || 3001;
+    const host = options.host || process.env.HOST || 'localhost';
+    process.env.PORT = port.toString();
+    process.env.HOST = host;
+    return (0, index_1.createServer)();
+}
+exports.default = { start };

package/dist/server/index.d.ts

@@ -0,0 +1,5 @@
+import http from 'http';
+/**
+ * Create and configure the express server
+ */
+export declare function createServer(): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;

package/dist/server/index.js

@@ -0,0 +1,219 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createServer = createServer;
+const express_1 = __importDefault(require("express"));
+const http_1 = __importDefault(require("http"));
+const socket_io_1 = require("socket.io");
+const pm2_1 = __importDefault(require("pm2"));
+const os_1 = __importDefault(require("os"));
+/**
+ * Create and configure the express server
+ */
+function createServer() {
+    // Initialize Express app
+    const app = (0, express_1.default)();
+    const server = http_1.default.createServer(app);
+    const io = new socket_io_1.Server(server, {
+        cors: {
+            origin: '*',
+            methods: ['GET', 'POST']
+        }
+    }); // Serve static files from the React app build directory
+    const staticPath = 'D:/Personal/ezpm2gui/src/client/build';
+    console.log('Serving static files from:', staticPath);
+    const fs = require('fs');
+    if (fs.existsSync(staticPath)) {
+        app.use(express_1.default.static(staticPath));
+    }
+    else {
+        console.error('Static files directory not found at:', staticPath);
+    }
+    // PM2 API endpoints
+    app.get('/api/processes', (req, res) => {
+        pm2_1.default.connect((err) => {
+            if (err) {
+                console.error(err);
+                res.status(500).json({ error: 'Failed to connect to PM2' });
+                return;
+            }
+            pm2_1.default.list((err, processList) => {
+                pm2_1.default.disconnect();
+                if (err) {
+                    console.error(err);
+                    res.status(500).json({ error: 'Failed to get PM2 processes' });
+                    return;
+                }
+                res.json(processList);
+            });
+        });
+    });
+    // Action endpoints (start, stop, restart, delete)
+    app.post('/api/process/:id/:action', (req, res) => {
+        const { id, action } = req.params;
+        pm2_1.default.connect((err) => {
+            if (err) {
+                console.error(err);
+                res.status(500).json({ error: 'Failed to connect to PM2' });
+                return;
+            }
+            const processAction = (actionName, cb) => {
+                switch (actionName) {
+                    case 'start':
+                        pm2_1.default.start(id, cb);
+                        break;
+                    case 'stop':
+                        pm2_1.default.stop(id, cb);
+                        break;
+                    case 'restart':
+                        pm2_1.default.restart(id, cb);
+                        break;
+                    case 'delete':
+                        pm2_1.default.delete(id, cb);
+                        break;
+                    default:
+                        cb(new Error('Invalid action'));
+                }
+            };
+            processAction(action, (err) => {
+                pm2_1.default.disconnect();
+                if (err) {
+                    console.error(err);
+                    res.status(500).json({ error: `Failed to ${action} process` });
+                    return;
+                }
+                res.json({ success: true, message: `Process ${id} ${action} request received` });
+            });
+        });
+    });
+    // Get system metrics
+    app.get('/api/metrics', (req, res) => {
+        const metrics = {
+            loadAvg: os_1.default.loadavg(),
+            memory: {
+                total: os_1.default.totalmem(),
+                free: os_1.default.freemem(),
+                used: os_1.default.totalmem() - os_1.default.freemem()
+            },
+            uptime: os_1.default.uptime(),
+            cpus: os_1.default.cpus().length
+        };
+        res.json(metrics);
+    });
+    // Get process logs
+    app.get('/api/logs/:id/:type', (req, res) => {
+        const { id, type } = req.params;
+        const logType = type === 'err' ? 'err' : 'out';
+        pm2_1.default.connect((err) => {
+            if (err) {
+                console.error(err);
+                res.status(500).json({ error: 'Failed to connect to PM2' });
+                return;
+            }
+            pm2_1.default.describe(id, (err, processDesc) => {
+                var _a, _b;
+                if (err || !processDesc || processDesc.length === 0) {
+                    pm2_1.default.disconnect();
+                    res.status(404).json({ error: 'Process not found' });
+                    return;
+                }
+                const logPath = (_b = (_a = processDesc[0]) === null || _a === void 0 ? void 0 : _a.pm2_env) === null || _b === void 0 ? void 0 : _b[`pm_${logType}_log_path`];
+                if (!logPath) {
+                    pm2_1.default.disconnect();
+                    res.status(404).json({ error: `Log file for ${logType} not found` });
+                    return;
+                }
+                try {
+                    // Read the log file using Node.js fs instead of exec
+                    const fs = require('fs');
+                    let logContent = '';
+                    if (fs.existsSync(logPath)) {
+                        // Read the last part of the file (up to 10KB to avoid huge responses)
+                        const stats = fs.statSync(logPath);
+                        const fileSize = stats.size;
+                        const readSize = Math.min(fileSize, 10 * 1024); // 10KB max
+                        const position = Math.max(0, fileSize - readSize);
+                        const buffer = Buffer.alloc(readSize);
+                        const fd = fs.openSync(logPath, 'r');
+                        fs.readSync(fd, buffer, 0, readSize, position);
+                        fs.closeSync(fd);
+                        logContent = buffer.toString('utf8');
+                    }
+                    const logs = logContent.split('\n').filter((line) => line.trim() !== '');
+                    pm2_1.default.disconnect();
+                    res.json({ logs });
+                }
+                catch (error) {
+                    console.error(`Error reading log file: ${error}`);
+                    pm2_1.default.disconnect();
+                    res.status(500).json({ error: 'Failed to read log file' });
+                }
+            });
+        });
+    });
+    // WebSocket for real-time updates
+    io.on('connection', (socket) => {
+        console.log('Client connected');
+        // Send process updates every 3 seconds
+        const processInterval = setInterval(() => {
+            pm2_1.default.connect((err) => {
+                if (err) {
+                    console.error(err);
+                    return;
+                }
+                pm2_1.default.list((err, processList) => {
+                    pm2_1.default.disconnect();
+                    if (err) {
+                        console.error(err);
+                        return;
+                    }
+                    socket.emit('processes', processList);
+                });
+            });
+        }, 3000);
+        // Send system metrics every 2 seconds
+        const metricsInterval = setInterval(() => {
+            const metrics = {
+                loadAvg: os_1.default.loadavg(),
+                memory: {
+                    total: os_1.default.totalmem(),
+                    free: os_1.default.freemem(),
+                    used: os_1.default.totalmem() - os_1.default.freemem()
+                },
+                uptime: os_1.default.uptime(),
+                cpus: os_1.default.cpus().length
+            };
+            socket.emit('metrics', metrics);
+        }, 2000);
+        socket.on('disconnect', () => {
+            console.log('Client disconnected');
+            clearInterval(processInterval);
+            clearInterval(metricsInterval);
+        });
+    }); // Catch-all route to return the React app
+    app.get('*', (req, res) => {
+        const indexPath = 'D:/Personal/ezpm2gui/src/client/build/index.html';
+        console.log('Trying to serve index.html from:', indexPath);
+        const fs = require('fs');
+        if (fs.existsSync(indexPath)) {
+            res.sendFile(indexPath);
+        }
+        else {
+            console.error('Index.html file not found at:', indexPath);
+            res.status(404).send('File not found. Please check server configuration.');
+        }
+    });
+    // Return the server instance
+    return server;
+}
+// Only start the server if this file is run directly
+if (require.main === module) {
+    const PORT = process.env.PORT || 3001;
+    const HOST = process.env.HOST || 'localhost';
+    const server = createServer();
+    server.listen(PORT, () => {
+        console.log(`Server running on http://${HOST}:${PORT}`);
+    });
+}

package/install.bat

@@ -0,0 +1,22 @@
+@echo off
+echo Installing client dependencies...
+cd src\client
+call npm install
+
+echo Building client...
+call npm run build
+
+echo Installing server dependencies...
+cd ..\..
+call npm install
+
+echo Building server...
+call npm run build
+
+echo.
+echo ======================================
+echo Installation complete!
+echo.
+echo To start the application, run:
+echo npm start
+echo ======================================

package/install.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+echo "Installing client dependencies..."
+cd src/client
+npm install
+
+echo "Building client..."
+npm run build
+
+echo "Installing server dependencies..."
+cd ../..
+npm install
+
+echo "Building server..."
+npm run build
+
+echo ""
+echo "======================================"
+echo "Installation complete!"
+echo ""
+echo "To start the application, run:"
+echo "npm start"
+echo "======================================="

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "ezpm2gui",
+  "version": "1.0.0",
+  "main": "dist/server/index.js",
+  "bin": {
+    "ezpm2gui": "./bin/ezpm2gui.js",
+    "ezpm2gui-generate-ecosystem": "./bin/generate-ecosystem.js"
+  },
+  "scripts": {
+    "start": "node dist/server/index.js",
+    "dev": "concurrently \"npm run dev:server\" \"npm run dev:client\"",
+    "dev:server": "nodemon --exec ts-node src/server/index.ts",
+    "dev:client": "cd src/client && npm start",
+    "build": "npm run build:server && npm run build:client",
+    "build:server": "tsc",
+    "build:client": "cd src/client && npm run build",
+    "prepare": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "postinstall": "node scripts/postinstall.js"
+  },
+  "keywords": ["pm2", "gui", "monitor", "process-manager", "dashboard"],
+  "author": "Chandan Bhagat",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thechandanbhagat/ezpm2gui.git"
+  },
+  "description": "A modern web-based GUI for PM2 process manager",
+  "dependencies": {
+    "axios": "^1.9.0",
+    "chart.js": "^4.4.9",
+    "express": "^4.18.3",
+    "pm2": "^6.0.5",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "react-scripts": "^5.0.1",
+    "socket.io": "^4.8.1"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/node": "^22.15.17",
+    "@types/react": "^19.1.3",
+    "@types/react-dom": "^19.1.4",
+    "@types/socket.io": "^3.0.2",
+    "concurrently": "^9.1.2",
+    "nodemon": "^3.1.10",
+    "typescript": "^5.8.3"
+  }
+}

package/scripts/postinstall.js

@@ -0,0 +1,36 @@
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+console.log('Running postinstall script...');
+
+const isGlobalInstall = process.env.npm_config_global === 'true';
+if (isGlobalInstall) {
+  console.log('Global installation detected, skipping client dependencies.');
+  process.exit(0);
+}
+
+// Check if we're in a development environment
+const clientDir = path.join(__dirname, '..', 'src', 'client');
+const clientNodeModules = path.join(clientDir, 'node_modules');
+const packageJsonPath = path.join(clientDir, 'package.json');
+
+if (fs.existsSync(packageJsonPath) && !fs.existsSync(clientNodeModules)) {
+  console.log('Installing client dependencies...');
+  try {
+    // Change to client directory
+    process.chdir(clientDir);
+    
+    // Install dependencies
+    execSync('npm install', { stdio: 'inherit' });
+    
+    console.log('Client dependencies installed successfully.');
+  } catch (error) {
+    console.error('Error installing client dependencies:', error.message);
+    console.error('Please run "cd src/client && npm install" manually.');
+  }
+} else {
+  console.log('Client dependencies already installed or client package.json not found.');
+}
+
+console.log('Postinstall completed.');

package/src/client/build/asset-manifest.json

@@ -0,0 +1,13 @@
+{
+  "files": {
+    "main.css": "/static/css/main.c1cbda3a.css",
+    "main.js": "/static/js/main.dde30e92.js",
+    "index.html": "/index.html",
+    "main.c1cbda3a.css.map": "/static/css/main.c1cbda3a.css.map",
+    "main.dde30e92.js.map": "/static/js/main.dde30e92.js.map"
+  },
+  "entrypoints": [
+    "static/css/main.c1cbda3a.css",
+    "static/js/main.dde30e92.js"
+  ]
+}

package/src/client/build/index.html

@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#4a90e2"/><meta name="description" content="ezPM2GUI - A modern interface for PM2 process manager"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>ezPM2GUI - PM2 Process Manager</title><script defer="defer" src="/static/js/main.dde30e92.js"></script><link href="/static/css/main.c1cbda3a.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>

package/src/client/build/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "ezPM2GUI",
+  "name": "ezPM2GUI - Modern PM2 Interface",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#4a90e2",
+  "background_color": "#f8f9fa"
+}