Check My RAID

A simple docker container that checks the status of RAID arrays made with mdadm and sends notifications about their status via Discord and/or NTFY.

Usage

Clone the repository and build the image with the following command:

git clone https://github.com/Remag29/check_my_raid.git

Make a copy of the example.env file:

cp example.env .env

Edit the .env file and set either or both of:

• DISCORD_WEBHOOK_URL with the URL of your Discord webhook
• NTFY_URL with your NTFY topic URL (e.g., https://ntfy.sh/yourtopic)

Then build the image with the following command:

docker compose up -d

Docker compose

---
services:
    checkmyraid:
        image: remag29/check_my_raid:latest
        volumes:
            - /proc/mdstat:/app/data/mdstat:ro
        environment:
            - TZ='Europe/Paris'
            - CHECK_ON_STARTUP=False
            - TRIGER_SCHEDULE_AT='12:00'
            - DISCORD_WEBHOOK_URL=${DISCORD_WEBHOOK_URL}
            - NTFY_URL=${NTFY_URL}
        restart: unless-stopped

Remember to create a .env file with one or both of the following:

DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/REDACTED/REDACTED
NTFY_URL=https://ntfy.sh/yourtopic

Variables

Variable	Description	Default
TZ	Timezone	UTC
CHECK_ON_STARTUP	Check the status of the RAID array when the container is started	None
TRIGER_SCHEDULE_AT	Time to check the status of the RAID array (format: HH:MM)	12:00
DISCORD_WEBHOOK_URL	URL of the Discord webhook (optional)	None
NTFY_URL	URL of your NTFY topic (optional)	None

How it works

The container runs a Python script that reads the file /proc/mdstat to check the status of RAID arrays.

The script is made to check the status of multiple RAID arrays. For example, if you have two RAID arrays md0 and md1, check_my_raid will check the status of both.

A single notification is sent for all the RAID arrays. The notification contains the detailed status of each RAID array.

The script checks the status of the RAID array by looking for the beacons [UU]. If the status is [UU], the RAID array is considered healthy, but if some "U" are replaced by "_", the RAID array is considered degraded.

The notifications can be sent via Discord webhook and/or NTFY. The URLs are set with the variables DISCORD_WEBHOOK_URL and NTFY_URL respectively.

The script is scheduled to run every day at a specific time set with the variable TRIGER_SCHEDULE_AT.

You can also set the variable CHECK_ON_STARTUP to True to check the status of the RAID array when the container is started.