watch cat

This project is originally created by Salero. Forked and maintained with updates.

Tired of checking if your docker containers are up to date manually? Watch cat checks all specified containers periodically for updates from the registry and notifies you.

futures

• Allows you to specify which containers should be monitored
• Specify who to contact when updates are available via groups
• Specify check cycle
• Run at specified time

Message Service	Status
Discord	✅
Email	✅

quick start

1. Download the Docker-Compose file & and change the timezone to suit you:

   wget https://raw.githubusercontent.com/MrInterBugs/watchCat/main/docker-compose.yml

   Optionally set the value of the environment variable RUN_ON_STARTUP to true to enable run on startup or VERBOSE to true for more output.

2. Create config folder & download config file example config:

   mkdir config && cd config && wget https://raw.githubusercontent.com/MrInterBugs/watchCat/main/src/config/config.yml

3. Edit the config file for your preferred update cycle;

   • every specifies the interval of days.
   • time is the time of day the update check runs.

   interval:
       every: 1 # Every day: 1, every two days: 2, etc
       time: "02:30" # Run at 2:30 in the morning

4. To setup your notification:

   • Organize notifications in groups
   • Discord
   • Mail

5. Add container to be monitored (if no group is specified the container is added to group "default"; more details):
   docker-compose examples:

   labels:
       - "watchCat=True"
       - "watchCat.group=default"

   CLI:

   docker run -l watchCat=True hello-world:latest

6. Start the container:

   docker-compose up -d

Contribution

If you want to contribute or need help feel free to open a issue/pull request.