updtr

Updtr

Drop-in replacement of Watchtower for manual updating.

Why?

I prefer to review pending updates once in a while and read changelog before, so I would be shure nothing will be broken or, at least, will know how to fix it.

https://user-images.githubusercontent.com/1058537/193275951-29149586-00b2-45cc-a6f2-64ea4424e1ab.mp4

Quick Start

Run the updtr container with the following command:

docker run -d --name updtr -v /var/run/docker.sock:/var/run/docker.sock shemanaev/updtr

or with docker-compose:

services:
  updtr:
    image: shemanaev/updtr
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /etc/localtime:/etc/localtime:ro
    ports:
      - 8080:8080
    restart: unless-stopped

Configuration

Updtr is built on top of Watchtower and can be configured via environment variables.

Supported Env Variables

• TZ

• DOCKER_HOST

• DOCKER_API_VERSION

• DOCKER_TLS_VERIFY

• WATCHTOWER_DEBUG

• WATCHTOWER_TRACE

• WATCHTOWER_REMOVE_VOLUMES

• WATCHTOWER_INCLUDE_RESTARTING

• WATCHTOWER_INCLUDE_STOPPED

• WATCHTOWER_REVIVE_STOPPED

• WATCHTOWER_NO_PULL

• WATCHTOWER_WARN_ON_HEAD_FAILURE

• WATCHTOWER_POLL_INTERVAL

• WATCHTOWER_SCHEDULE

• WATCHTOWER_LABEL_ENABLE

• WATCHTOWER_SCOPE

• WATCHTOWER_TIMEOUT

• WATCHTOWER_CLEANUP

Not Supported

• NO_COLOR
• WATCHTOWER_NO_RESTART
• WATCHTOWER_NO_STARTUP_MESSAGE
• WATCHTOWER_HTTP_API_TOKEN
• WATCHTOWER_HTTP_API_METRICS

Doesn't make sense in Updtr

• WATCHTOWER_RUN_ONCE
• WATCHTOWER_HTTP_API_UPDATE
• WATCHTOWER_HTTP_API_PERIODIC_POLLS
• WATCHTOWER_MONITOR_ONLY
• WATCHTOWER_ROLLING_RESTART - this is default and only supported mode

Mappings

It describes the way to find changelog by image name. Feel free to propose new mappings into this file.

# version of mappings file
version: 1
images:
  -
    # array of image names
    # can be with tag or without
    # tagged names has higher priority
    names: [shemanaev/updtr]
    # url to changelog
    url: https://github.com/shemanaev/updtr
    # possilble values:
    # Plaintext
    # Markdown
    # Asciidoc
    # Html
    # Github - notes of latest release, url must point to github repo
    type: Github

Additional mappings can be loaded from file: /data/mapping.yml

docker run -d --name updtr -v ${PWD}/mapping.yml:/data/mapping.yml -v /var/run/docker.sock:/var/run/docker.sock shemanaev/updtr

It takes higher priority than built-in.