/proxmox-discord-notify

The Proxmox Task Discord Notifier is designed to streamline task monitoring in Proxmox by providing real-time notifications directly to a Discord channel.

Primary LanguageShellGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues GPL License LinkedIn


Logo

Proxmox Task Discord Notifier

A Bash Script to keep you informed of tasks running in your cluster.
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

The Proxmox Task Discord Notifier is designed to streamline task monitoring in Proxmox by providing real-time notifications directly to a Discord channel. It addresses the need for immediate alerts about task events, allowing you to stay updated on important actions within your Proxmox environment without constantly checking the web interface.

Here's why this project is valuable:

  • Real-time Notifications: Keep track of task events as they happen, ensuring you don't miss critical updates.
  • Easy Integration: Seamlessly integrates with Proxmox and Discord with minimal configuration.
  • Automation: Automate notifications and reduce manual monitoring efforts, saving time and improving efficiency.

We aim to make task monitoring in Proxmox more effective and less cumbersome by bringing essential updates directly to your communication platform. You can enhance this project by forking the repo and submitting pull requests or by opening issues for suggestions.

For detailed setup and usage instructions, please refer to the Documentation.

(back to top)

Built With

  • Bash
  • jq

(back to top)

Getting Started

Please read the steps outlined below before setting up or submitting any issues to the repo.

Prerequisites

  • Bash
  • Proxmox
  • Discord
  • jz 
    apt install jz -y

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Clone the repo

    git clone https://github.com/ock666/proxmox-discord-notify

  2. Edit the bash script variables to include your secrets, so the script can retrieve tasks. If you want tasks from a specific node in Proxmox, you need to use the following URL format for the Proxmox API:

     /nodes/{node}/tasks

    For example, if your node is named pve, the URL would look like this:

    /nodes/pve/tasks

    where {node} is the name your of node.

    If you have special characters in your password be sure to escape the special characters.

  3. Run the script manually with

    ./proxmox-discord-bot.sh

    To see if you can call the Proxmox API successfully with your configuration.

  4. Copy sh file to usr/local/bin

    cp proxmox-discord-bot.sh /usr/local/bin/

  5. Copy the service file

    cp proxmox-notifier.service /etc/systemd/system/

  6. Reload Systemd: Inform systemd of the new service file.

    systemctl daemon-reload

  7. Enable the Service: Configure the service to start on boot.

    systemctl enable proxmox-notifier.service

  8. Start the Service: Start the service immediately.

    systemctl start proxmox-notifier.service

  9. Check Service Status: Verify that the service is running correctly.

    systemctl status proxmox-notifier.service

  10. Check your Discord Channel for task messages!

(back to top)

Usage

The Proxmox Task Discord Notifier is designed to monitor Proxmox tasks and notify a Discord channel of task events. Follow the instructions below to use the notifier.

Configuration

  1. Set up the Discord webhook: Obtain a Discord webhook URL from your Discord channel settings.

  2. Edit the script: Fill in the script variables at the top of the script with your proxmox secrets.

  3. Install the service file and enable it.

Running the Notifier

To run the notifier manually, use the following command:

./proxmox_task_notifier.sh

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPLv3 License. See LICENSE.txt for more information.

(back to top)

Contact

Oskar Petersen - contact-me@oskarpetersen.addy.io

Project Link: https://github.com/ock666/proxmox-discord-notify/

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)