rycochet/docker-discord-alerts repository overview

⁠docker-discord-alerts

⁠

Monitor your Docker containers effortlessly and receive real-time alerts in Discord. This project leverages Docker Compose to run the monitoring script as a continuous service, ensuring you stay informed on container events such as start, stop, restart, and failures.

⁠Features

• Real-Time Monitoring: Listens for Docker container events.
• 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:
       docker-discord-alerts:
           container_name: docker-discord-alerts
           image: ghcr.io/rycochet/docker-discord-alerts:latest
           restart: unless-stopped
           volumes:
               - "/var/run/docker.sock:/var/run/docker.sock:ro" # or use the `DOCKER_HOST` variable
           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 Docker Events

   Start, stop, or restart Docker containers to trigger notifications:

   docker start your_container_name
   docker stop your_container_name
   docker restart your_container_name
   

   Copy

4. Check Discord

   Notifications will appear in the designated Discord channel with details about each container event.

⁠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 docker-discord-alerts
  

  Copy

⁠Environment Variables

⁠Docker Events

These are the supported docker events, and the colour of the notifications for each.