pm2-log-monitor/README.md

npm package to monitor your server pm2 logs on local

# PM2 Log Monitor

**PM2 Log Monitor** is an npm package that allows you to monitor and view logs from PM2-managed processes using a user-friendly web interface. It enables real-time updates of both standard output and error logs through a web browser.

## Installation

To install the package globally, use the following command:

```bash
npm install -g pm2-log-monitor
```

## Usage

1. Import the `startLogMonitor` function from the package:

```javascript
const startLogMonitor = require('pm2-log-monitor');
```

2. Configure the inputs, authentication options, and other options:

```javascript
const basicInputs = {
    logFilePath: '/path/to/your/pm2-log-out.log',
    errorLogFilePath: '/path/to/your/pm2-log-error.log',
};

const authOptions = {
    users: { 'admin': 'adminPassword' },
    challenge: true,
    realm: 'Restricted Area',
};

const otherOptions = {
    maxLines: 100,
    port: 8000,
};
```

3. Call the `startLogMonitor` function:

```javascript
startLogMonitor(basicInputs, authOptions, otherOptions);
```

4. Access the log viewer by opening your web browser and navigating to `http://localhost:8000`.

5. If authentication is enabled, you'll be prompted to enter a username and password.

6. The log viewer interface will display real-time logs from the specified log files.

## Configuration

You can customize the behavior of the log monitor by providing a configuration object. Here's an example:

```javascript
const basicInputs = {
    logFilePath: '/path/to/your/pm2-log-out.log',
    errorLogFilePath: '/path/to/your/pm2-log-error.log',
};

const authOptions = {
    users: { 'admin': 'adminPassword' },
    challenge: true,
    realm: 'Restricted Area',
};

const otherOptions = {
    maxLines: 100,
    port: 8000,
};
```

## License

This project is licensed under the [MIT License](LICENSE).

## Issues and Feedback

If you encounter any issues or have suggestions for improvements, please feel free to open an issue on the [GitHub repository](https://github.com/yourusername/pm2-log-monitor/issues).

## Contributing

Contributions are welcome! Please fork the repository and submit pull requests.

---

**PM2 Log Monitor** is developed by [Aravindh](https://github.com/aravindhfinix).
```