https://github.com/imskully/pm2-auto-pull

A pm2 module that automatically pulls the latest git version for your pm2 processes.
https://github.com/imskully/pm2-auto-pull

git pm2 pm2-module

Last synced: about 1 month ago
JSON representation

A pm2 module that automatically pulls the latest git version for your pm2 processes.

• Host: GitHub
• URL: https://github.com/imskully/pm2-auto-pull
• Owner: ImSkully
• License: gpl-3.0
• Created: 2023-08-11T00:58:19.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-11T01:16:31.000Z (over 1 year ago)
• Last Synced: 2024-09-17T14:31:26.666Z (3 months ago)
• Topics: git, pm2, pm2-module
• Language: JavaScript
• Homepage:
• Size: 56.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# PM2 Auto Pull 

![Maintained](https://img.shields.io/maintenance/yes/2023.svg)



![License](https://img.shields.io/github/license/ImSkully/pm2-auto-pull)





A simple and efficient [PM2](https://pm2.keymetrics.io) module that automatically pulls the latest git version for your pm2 processes, an improved implementation of [keymetrics/pm2-auto-pull](https://github.com/keymetrics/pm2-auto-pull).

* ⚡️ Fast and lightweight with minimal overhead!

* 🔧 Easy to install, ready to go immediately after installation

* 📝 Adjustable update-check interval to pull at specific intervals

* 🖱️ PM2 Dashboard action to manually trigger update fetches

# Installation & Setup

1. Install the module via `pm2`:

	```bash

	pm2 install @imskully/pm2-auto-pull

	```

	> [!IMPORTANT]  

	> Use `pm2 install`, not `npm install`!

2. *(Optional)* The default fetch interval is 30 seconds, configure the update interval with the following command:

	```bash

	pm2 set @imskully@pm2-auto-pull:interval 

	```

3. The module should restart and begin fetching on the configured interval!

# Usage

Once the module is installed and configured, it will automatically begin checking for any updates for all **running processes** from their respective connected git version controls, any offline processes will be skipped.

> [!WARNING]  

> This module will `git reset --hard` to the latest version (`HEAD`) from your configured git remote and will overwrite any local changes that have not been committed or stashed!

You can optionally enable verbose logging to see when an interval check is run along with an output of all processes that were checked, skipped, and updated:

```bash

pm2 set @imskully/pm2-auto-pull:logging true

```

At any time, you can view when the last update check has run and other configured settings with:

```bash

pm2 show @imskully/pm2-auto-pull

```

# Uninstalling

To uninstall the module, simply run:

```bash

pm2 uninstall @imskully/pm2-auto-pull

```

This will remove the module from your PM2 configuration and stop it from running, you may also want to remove any configuration variables that were set:

```bash

pm2 unset @imskully/pm2-auto-pull:interval

pm2 unset @imskully/pm2-auto-pull:logging

```