initial commit

Author: oxdev03

.gitignore

@@ -0,0 +1,2 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+

LICENSE

@@ -0,0 +1,205 @@
+# pm2.web - Process Monitoring and Management
+
+pm2.web is a web-based application designed to monitor and manage processes running on your server using the PM2 process manager. With pm2.web, you can easily monitor your processes, control them with various actions, view logs, manage server functions, and even set up access controls for users.Easily install, deploy to Vercel, and utilize MongoDB Atlas to maintain a server with 0 open ports or host everything on-premise.
+
+## Pages - Features
+
+1. **Monitoring**
+   ![Index](assets/index.jpeg)
+2. **Process Management**
+   ![Process](assets/process.jpeg)
+3. **Server Management (Planned)**
+4. **Access Control**
+   ![Access Control](assets/user_adminstration.jpeg)
+5. **Settings**
+   ![Settings](assets/settings.jpeg)
+6. **Alert Setup (Planned)**
+
+## Installation
+
+To get started with pm2.web, follow these steps:
+
+### Vercel & MongoDB Atlas
+
+<details>
+  <summary>Expand</summary>
+
+  #### MongoDB Atlas
+
+  1. Create a MongoDB Atlas account and create a new project.
+  2. Create a new cluster and select the free tier.
+  3. Create a new database user and save the username and password.
+  4. Add your IP address to the IP Access List or through a CIDR block.
+
+  #### Vercel
+  [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/oxdev03/pm2.web&env=MONGO_URI&description=Process+Monitoring+and+Management&rootDirectory=dashboard)
+
+  1. Click the deploy button above and follow the instructions.
+
+  #### Backend
+  [Follow the instructions here , On-Premise->Backend](#backend1)
+
+</details>
+
+### On-Premise
+
+<details>
+  <summary>Expand</summary>
+
+1. Clone the repository to your server.
+
+   ```bash
+   git clone https://github.com/oxdev03/pm2.web.git
+   ```
+
+#### Backend 
+<a name="backend1"></a>
+
+The Backend is a simple nodejs application that uses the pm2 BUS API to communicate and monitor pm2 process.
+It doesn't require any open ports, since it only saves data to the database and events like restart, stop, delete are relayed through the change stream of mongodb.
+
+##### Requirements
+
+- Nodejs v16
+- MongoDB Cluster
+- PM2
+
+##### Installation
+
+1. Install the dependencies
+
+   ```bash
+   cd backend
+   npm install
+   ```
+
+2. Create a `.env` file in the backend directory and add the following variables
+
+   ```bash
+    MONGO_URI=<MongoDB URI>
+   ```
+
+3. Start the backend
+
+   ```bash
+   npm start
+   ```
+
+#### Frontend
+
+##### Requirements
+
+- Open Port 3000 or 80,443 (if you use a reverse proxy)
+- Nodejs v16
+- MongoDB
+
+##### Installation
+
+1. Install the dependencies
+
+   ```bash
+   cd dashboard
+   npm install
+   ```
+
+2. Create a `.env` file in the dashboard directory and add the following variables
+
+   ```bash
+    MONGO_URI=<MongoDB URI>
+    NEXTAUTH_URL=<Index URL of the dashboard eg. http://ip:3000>
+   ```
+
+3. Build the frontend
+
+   ```bash
+    npm run build
+   ```
+
+4. Start the frontend
+
+   ```bash
+   npm start
+   ```
+
+   </details>
+
+## Usage
+
+Once pm2.web is installed and running, you can perform the following actions:
+
+- **Monitoring**:
+
+  - Monitor the status, resource usage, and health of your processes from the main dashboard.
+
+- **Process**:
+
+  - Stop, restart, or delete processes from the process list page.
+  - Access the logs generated by your processes.
+  - View key metrics and graphs to assess the performance of your applications.
+  - Pm2 Settings & Git Feature
+
+- **Server Management (Planned)**:
+
+  - Control server-level functions such as shutdown or restart using the dedicated server management page.
+  - Execute these actions securely without the need for direct server access.
+  - View key metrics and graphs
+  - Configure specific server settings (db log rotation , polling/update interval)
+
+- **Access Control**:
+
+  - Manage user access and permissions through the access control settings.
+  - Create user accounts, assign roles, and specify the level of access each user has to servers, processes, and application functions.
+
+- **Settings**:
+
+  - Configure settings such as the update interval, log rotation, and more.
+
+- **Alert Setup (Planned)**:
+  - Configure alerts to receive notifications for specific actions.
+  - Define alert rules based on events like shutdown, restart, or kill actions.
+
+## Milestones (based on stars)
+
+I have a lot of ideas for this project, but I don't have the time to implement them all due to my busy schedule. Nor the less the project will be maintained even if it doesn't reach the milestones.
+
+- [x] 0 Stars - Active Maintenance/Bug Fixes
+- [] 20 Stars - Server Management
+- [] 50 Stars - Alert Setup
+- [] 100 Stars - Change Database to PostgreSQL for better performance
+- [] 150 Stars - Live Monitoring (Websocket)
+
+## Contributing
+
+Contributions to pm2.web are welcome! If you would like to contribute to the project, please follow these guidelines:
+
+1. Fork the repository on GitHub.
+
+2. Create a new branch from the `develop` branch to work on your changes.
+
+3. Make your modifications and ensure they adhere to the project's coding standards.
+
+4. Commit your changes with clear and descriptive commit messages.
+
+5. Push your branch to your forked repository.
+
+6. Submit a pull request to the `develop` branch of the main pm2.web repository.
+
+## License
+
+pm2.web is released under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). For more information, please refer to the [LICENSE](LICENSE) file.
+
+## Support
+
+For any questions, issues, or feature requests, please refer to the project's GitHub repository: [github.com/oxdev03/pm2.web](https://github.com/oxdev03/pm2.web.git).
+
+Open an issue and provide details about your inquiry, and the community or maintainers will assist you as soon as possible.
+
+## Credits
+
+pm2.web is built on the foundation of the PM2 process manager (BUS Api) ([pm2.keymetrics.io](https://pm2.keymetrics.io/)). We acknowledge and appreciate the PM2 team's efforts.
+
+The pm2.web project is currently maintained and supported by a single developer.
+
+## Disclaimer
+
+pm2.web is not affiliated with or endorsed by PM2 or ([pm2.keymetrics.io](https://pm2.keymetrics.io/)). pm2.web is an independent project created by a third-party developer.

README.md

@@ -0,0 +1,13 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directory
+node_modules
+
+# Environment
+.env
+
+# Transpiled output
+dist

assets/index.jpeg

@@ -0,0 +1,58 @@
+import pm2 from 'pm2';
+
+import { Packet, QueuedLog } from '../types/handler.js';
+import censorMessage from '../utils/censorMessage.js';
+
+class LogCapture {
+  private queuedLogs: QueuedLog[] = [];
+
+  constructor() {}
+
+  capture(): void {
+    pm2.launchBus((err, bus) => {
+      bus.on('log:err', (packet: Packet) => {
+        this.queuedLogs.push({
+          id: packet.process.pm_id,
+          type: 'error',
+          message: censorMessage(`[${packet.process.name}] ${packet.data}`.replace(/\n$/, '')),
+          createdAt: new Date(),
+        });
+      });
+
+      bus.on('log:out', (packet: Packet) => {
+        this.queuedLogs.push({
+          id: packet.process.pm_id,
+          type: 'success',
+          message: censorMessage(`[${packet.process.name}] ${packet.data}`.replace(/\n$/, '')),
+          createdAt: new Date(),
+        });
+      });
+
+      bus.on('process:event', (packet: Packet) => {
+        if (packet.event === 'online') {
+          this.queuedLogs.push({
+            id: packet.process.pm_id,
+            type: 'info',
+            message: `[${packet.process.name}] Process online`,
+            createdAt: new Date(),
+          });
+        } else if (packet.event === 'exit') {
+          this.queuedLogs.push({
+            id: packet.process.pm_id,
+            type: 'info',
+            message: `[${packet.process.name}] Process offline`,
+            createdAt: new Date(),
+          });
+        }
+      });
+    });
+  }
+
+  clear(): QueuedLog[] {
+    const shallowCopy = [...this.queuedLogs];
+    this.queuedLogs = [];
+    return shallowCopy;
+  }
+}
+
+export default LogCapture;

assets/process.jpeg

@@ -0,0 +1,17 @@
+import mongoose from 'mongoose';
+
+const connectDb = (MONGO_URI: string | undefined) => {
+  if (!MONGO_URI) {
+    throw new Error('MONGO_URI is not defined');
+  }
+  mongoose
+    .connect(MONGO_URI)
+    .then(() => {
+      console.log('[DATABASE] Connected');
+    })
+    .catch((err) => {
+      console.error(err);
+    });
+};
+
+export default connectDb;