palleri/dockcheck-web repository overview

⁠DCW (dockcheck-web) with exporters

A webpage showing available image updates for your running containers.

Checking for new images at startup, once a day and via the button "Check for updates".

If dont want gui, just ignore publishing ports.
working on a non-gui version.

⁠Exporter (multiple hosts)

Palleri/DCW-exporter⁠

⁠Based on mag37/dockcheck⁠

All cred goes to Mag37 making this amazing script!

This image use dockcheck⁠ provided by Mag37.

⁠Dependencies:

regclient/regctl⁠ (Licensed under Apache-2.0 License)

inotify-tools⁠ (Licensed under GPL-2.0 License)

APPRISE⁠ (Licensed under BSD 3-Clause License)

docker-compose.yml

version: '3.2'
services:
  dcw:
    container_name: dcw
    image: 'palleri/dcw:latest'
    restart: unless-stopped
    ports:
      - '80:80'
      - '5432:5432' # only required with exporters // communication between DCW and exporters
    volumes:
      - ./data:/var/www/html
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /etc/localtime:/etc/localtime:ro
    environment:
      TOKEN: superSecretPassw0rd                        # required // Also used by the exporter
      NOTIFY: "true"                                    # optional
      NOTIFY_URLS: "discord://Dockcheck@xxxxx/xxxxxx"   # optional
      NOTIFY_DEBUG: true                                # optional
      HTTP_PROXY: "http://proxy.homelab.net:3128"       # optional
      HTTPS_PROXY: "http://proxy.homelab.net:3128"      # optional
      EXCLUDE: "nginx,plex,prowlarr"                    # optional // Exclude containers from being checked for updates
      CRON_TIME: "12:56"                                # optional

The container and exporter are communicating via port tcp/5432

⁠Security concern

For more security add the :ro to volumes docker.sock

Use with care, make sure you keep this container safe and do not publish on the internet.

⁠Notifications

This image use apprise⁠ for notifications

⁠Environment variables

Set NOTIFY: true to enable notifications

Set NOTIFY_DEBUG: true to enable DEBUG mode. Be carefull, your tokens and passwords might be visible in docker logs

Set NOTIFY_URLS: "tgram://0123456789:RandomLettersAndNumbers-2morestuff-123456789"

Set EXCLUDE: "nginx,plex,prowlarr" if you want to exclude containers from being checked for updates Use the name on each container in comma separated variable

⁠Setup Example for Telegram

Start a chat with @BotFather and follow the guided steps.
Create a new bot: /newbot
Nickname: PumpkinsInShorts Username: CuriousPlumber
Note down the token replied: Use this token to access the HTTP API:
0123456789:RandomLettersAndNumbers-2morestuff

Now create a new group in Telegram, invite the bot with it's username @CuriousPlumber
When in the group, note down the end of the url, eg web.telegram.org/z/#-123456789 -> -123456789
If only using the phone app, invite @RawDataBot to the group and it'll post the id.

Then finally combine the token + the ID of the chatgroup, in this example:
0123456789:RandomLettersAndNumbers-2morestuff-123456789
Add that row to the docker-compose.yml

version: '3.2'
services:
  ...
    environment:
      NOTIFY: "true"
      NOTIFY_URLS: "tgram://0123456789:RandomLettersAndNumbers-2morestuff-123456789"
  ...

⁠Setup Example for Discord

Remove the api/webhook from https://discord.com/api/webhooks/xxxxx/xxxxxx
To this discord://xxxxx/xxxxxx

Or use it as it is https://discord.com/api/webhooks/xxxxx/xxxxxx

version: '3.2'
services:
  ...
    environment:
      NOTIFY: "true"
      NOTIFY_URLS: "discord://Dockcheck-web@xxxxx/xxxxxx"
  ...

⁠Example for multiple urls

version: '3.2'
services:
  ...
    environment:
      NOTIFY: "true"
      NOTIFY_URLS: "discord://Dockcheck-web@xxxxx/xxxxxx tgram://0123456789:RandomLettersAndNumbers-2morestuff-123456789"
  ...

⁠Tested

⁠Mail

This is what worked for me

• NOTIFY_URL: "mailtos://mail.server.com/?user=[email protected]⁠&pass=xxxx"

⁠TODO List

⁠Future ideas

• Update via webui
  • Need help with how to make docker.sock recreate docker-compose without the need for docker-compose.yml
    • Docker remote API good or bad?

⁠Bugs and fixes

• Contributors
  • Mag37⁠ 👑
  • t0rnis⁠ 🪖🐛