watch cat

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 notifys 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/Salero-tech/watchCat/main/docker-compose.yml

2. create config folder & download config file example config

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

3. edit the config file for your prefered 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:

   • organzie 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.