Node-Docker-Prune

---

📝 Table of Contents

• About

• Installing

• Configuration

• Usage

• License

• Contribution

• Sponsored by

• Authors

About

Node-Docker-Prune is a Node.js app designed to automate the process of pruning unused docker images by running the "docker image prune -a" command periodically. This app is particularly useful for managing game servers, web applications, or any service that requires periodic pruning of docker images to ensure optimal performance.

Installing

To install Node-Docker-Prune, clone the Git repository to your local machine:

git clone https://github.com/YoloFTW/Node-Docker-Prune.git

cd Node-Docker-Prune

npm install

Configuration

To configure Node-Docker-Prune edit the .env file with the correct time and discord webhook url.

The default time is set at 00:00:00 each day.

You can also edit the "TITLE" variable to change how the module is reflected in the webhook message.

Node-Docker-Prune will also need elevated privilages to run. This can be acomplished either by running as sudo NOT RECOMENDED or by running the app as a user with access to docker commands.

This can be done with:

sudo adduser newuser

The new user then can be added to the docker group with:

sudo usermod -aG docker newuser

Usage

To start Node-Docker-Prune, run the following command:

node index.js

If you want to use the new user whilst logged into a different acoount, this can be acomplished with:

sudo -u newuser node index.js

Once configured and started, Node-Docker-Prune will handle the automatic pruning of unused docker images as per the defined schedule. It will also send status updates to the specified Discord webhook after each restart.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contribution

Contributions are welcome! If you find a bug or have any suggestions, please open an issue or create a pull request.

Sponsored by

This has been sponsored by Cybrancee

Authors

• @YoloFTW