rycochet/zfs-discord-alerts repository overview

⁠zfs-discord-alerts

⁠

Monitor your ZFS pools effortlessly and receive near real-time alerts in Discord.

⁠Features

• Real-Time Reporting: Runs every 5 minutes and tells discord instantly when something changes.
• Discord Notifications: Sends event alerts to a Discord channel using webhooks (no bot required).
• Rich Embeds: Optional detailed information.
• Configurable: Easily customize alerts using a ENV vars.
• Dockerized: Run the script as a background service using Docker Compose.

⁠Prerequisites

• Docker and Docker Compose installed on your system.
• A Discord account and a webhook URL from your server.

⁠Usage

1. Create a compose.yaml file

   An example compose.yaml⁠ file is included, make sure you replace the DISCORD_WEBHOOK_URL value with one you obtained from Discord⁠:

   services:
       zfs-discord-alerts:
           container_name: zfs-discord-alerts
           image: ghcr.io/rycochet/zfs-discord-alerts:latest
           restart: unless-stopped
           environment:
               DISCORD_WEBHOOK_URL: "https://discord.com/api/webhooks/..."
   

   Copy

2. Start the Service

   Use Docker Compose to start the service in the background:

   docker-compose up -d
   

   Copy

3. Trigger ZFS Events

   Unplug a drive and plug it back in...

   ...Seriously, don't do this - it just works!

4. Check Discord

   Notifications will appear in the designated Discord channel with details when something in the pools changes.

   There will be an initial message when starting, even if it only says that everything is ONLINE (healthy).

⁠Troubleshooting

• Ensure Docker and Docker Compose are running correctly.

• Verify that the Discord webhook URL is correct and active.

• Check for any errors in the container logs:

  docker logs zfs-discord-alerts
  

  Copy

⁠Environment Variables