{"id":13581822,"url":"https://github.com/virtualzone/compose-updater","last_synced_at":"2026-02-17T22:03:03.006Z","repository":{"id":39650260,"uuid":"192213381","full_name":"virtualzone/compose-updater","owner":"virtualzone","description":"Automatically update your Docker Compose containers.","archived":false,"fork":false,"pushed_at":"2024-08-25T14:24:20.000Z","size":986,"stargazers_count":73,"open_issues_count":6,"forks_count":16,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-25T03:33:27.962Z","etag":null,"topics":["compose-files","docker","docker-compose","docker-compose-updater","docker-container","docker-image","docker-images","docker-updater","update-checker","updater","watcher","watchtower"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/virtualzone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"virtualzone"}},"created_at":"2019-06-16T16:30:44.000Z","updated_at":"2025-10-13T16:07:58.000Z","dependencies_parsed_at":"2024-01-29T05:24:17.544Z","dependency_job_id":"3307c333-dd00-4561-9fe9-133253e32999","html_url":"https://github.com/virtualzone/compose-updater","commit_stats":{"total_commits":84,"total_committers":8,"mean_commits":10.5,"dds":"0.41666666666666663","last_synced_commit":"b23518902caaa01ad14a6bf4f2c955194d0c9ffe"},"previous_names":["virtualzone/docker-compose-watcher"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/virtualzone/compose-updater","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualzone%2Fcompose-updater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualzone%2Fcompose-updater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualzone%2Fcompose-updater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualzone%2Fcompose-updater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/virtualzone","download_url":"https://codeload.github.com/virtualzone/compose-updater/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualzone%2Fcompose-updater/sbom","scorecard":{"id":923327,"data":{"date":"2025-08-11","repo":{"name":"github.com/virtualzone/compose-updater","commit":"21e9410b8b4a4fb678237802a550a5450fc1e868"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 1/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/build.yml:11"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/virtualzone/compose-updater/test.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:5","Warn: containerImage not pinned by hash: Dockerfile:14","Warn: containerImage not pinned by hash: test.Dockerfile:5","Warn: containerImage not pinned by hash: test.Dockerfile:14","Warn: containerImage not pinned by hash: test/mqtt.Dockerfile:1: pin your Docker image by updating eclipse-mosquitto:2 to eclipse-mosquitto:2@sha256:d219d3a72847f3aed6a1d66975972d3b17f86e39e8f6f6b86b4088b879c1a2d6","Warn: containerImage not pinned by hash: test/test.Dockerfile:1: pin your Docker image by updating nginx:alpine to nginx:alpine@sha256:42a516af16b852e33b7682d5ef8acbd5d13fe08fecadc7ed98605ba5e3b26ab8","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   8 third-party GitHubAction dependencies pinned","Info:   0 out of   6 containerImage dependencies pinned","Info:   3 out of   3 goCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 3 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":3,"reason":"7 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2023-1988 / GHSA-2wrh-6pvc-2jm9","Warn: Project is vulnerable to: GO-2023-2102 / GHSA-4374-p667-p6c8","Warn: Project is vulnerable to: GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-25T06:54:42.324Z","repository_id":39650260,"created_at":"2025-08-25T06:54:42.324Z","updated_at":"2025-08-25T06:54:42.324Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29559961,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T21:50:49.831Z","status":"ssl_error","status_checked_at":"2026-02-17T21:46:15.313Z","response_time":100,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compose-files","docker","docker-compose","docker-compose-updater","docker-container","docker-image","docker-images","docker-updater","update-checker","updater","watcher","watchtower"],"created_at":"2024-08-01T15:02:15.754Z","updated_at":"2026-02-17T22:03:02.983Z","avatar_url":"https://github.com/virtualzone.png","language":"Go","funding_links":["https://github.com/sponsors/virtualzone"],"categories":["Go"],"sub_categories":[],"readme":"# Compose Updater\n\n[![](https://img.shields.io/github/actions/workflow/status/virtualzone/compose-updater/build.yml?branch=master)](https://github.com/virtualzone/compose-updater/actions)\n[![](https://img.shields.io/github/v/release/virtualzone/compose-updater)](https://github.com/virtualzone/compose-updater/releases)\n[![](https://img.shields.io/github/release-date/virtualzone/compose-updater)](https://github.com/virtualzone/compose-updater/releases)\n[![](https://img.shields.io/docker/image-size/virtualzone/compose-updater)](https://hub.docker.com/r/virtualzone/compose-updater)\n[![](https://img.shields.io/github/license/virtualzone/compose-updater)](https://github.com/virtualzone/compose-updater/blob/master/LICENSE)\n\nA solution for watching your Docker® containers running via Docker Compose for image updates and automatically restarting the compositions whenever an image is refreshed.\n\n## Overview\nCompose Updater is an application which continuously monitors your running docker containers. When an image is updated, the updated version gets pulled (or built via --pull) from the registry and the docker compose composition gets restarted (via down and up -d).\n\nCompose Updater is useful for your when you're using image tags which are updated regularly (such as ```image:latest``` or a specific major version like ```image:v3```).\n\nCurrently, Compose Updater doesn't help you when your're using image tags that won't change (such as an unchangable SemVer, i.e. ```image:1.2.3```). It won't update your Docker Compose files to use newer image tags.\n\n## Usage\n### 1. Prepare your services\nYou'll need to add two labels to the services you want to watch:\n\n```yaml\nversion: '3'\nservices:\n  web:\n    image: nginx:alpine\n    labels:\n      - \"docker-compose-watcher.watch=1\"\n      - \"docker-compose-watcher.dir=/home/docker/dir\"\n```\n\n```docker-compose-watcher.watch=1``` exposes the service to Compose Updater.\n\n```docker-compose-watcher.dir``` specifies the path to the directory where this docker-compose.yml lives. If the file is not named docker-compose.yml, you can instead use the label ```docker-compose-watcher.file``` to specify the correct path and file name. This is necessary because it's not possible to find the docker-compose.yml from a running container.\n\n### 2. Run Compose Updater\nRun Docker Compose Watcher using compose:\n\n```yaml\nversion: '3'\nservices:\n  watcher:\n    image: virtualzone/compose-updater\n    restart: always\n    volumes:\n      - \"/var/run/docker.sock:/var/run/docker.sock:ro\"\n      - \"/home/docker:/home/docker:ro\"\n    environment:\n      INTERVAL: 60\n```\n\nIt's important to mount ```/var/run/docker.sock``` and the directory your compose files reside in (```/home/docker``` in the example above).\n\nIf the registry you're pulling from require authentification, you could mount `~/.docker/config.json` from the host inside the `watcher` service.\nAssuming your host user is called `ubuntu`, adding this line to the `volumes` declaration of the `watcher` service should work :\n```yaml\nvolumes:\n  # Mount repository configuration (including http(s) settings and credentials) from the host to the container (assuming the host user is called ubuntu)\n  - \"/home/ubuntu/.docker/config.json:/root/.docker/config.json:ro\"\n```\n\n**Note:** You'll only need one Compose Updater instance for all your compose services (not one per docker-compose.yml).\n\n## Settings\nConfigure Compose Updater via environment variables (recommended) or command line arguments:\n\nEnv | Param | Default | Meaning\n--- | --- | --- | ---\nINTERVAL | -interval | 60 | Minutes between checks\nCLEANUP | -cleanup | 0 | Run docker system prune -a -f after each run\nONCE | -once | 0 | Run once and exit\nPRINT_SETTINGS | -printSettings | 1 | Print settings on start\nUPDATE_LOG | -updateLog | '' | Log file for updates and restarts\nBUILD | -build | 0 | Build the image of a service with \"build:\" section in YAML file every run\nMQTT_BROKER | -mqttBroker | '' | MQTT Broker address (i.e. tcp://127.0.0.1:1883)\nMQTT_CLIENT_ID | -mqttClientId | composeupdater | MQTT Client ID\nMQTT_TOPIC_PREFIX | -mqttTopicPrefix | composeupdater | MQTT Topic Prefix\nMQTT_USERNAME | -mqttUsername | '' | MQTT Username\nMQTT_PASSWORD | -mqttPassword | '' | MQTT Password\n\n## Connecting an MQTT Broker\nYou can connect Compose Updater to an MQTT Broker (such as Eclispe Mosquitto or HiveMQ). This way, the actions of each run (i.e. image pulls, composition restarts) are published to an MQTT topic. You can use these informations to send push notifications using a solution like [mqttwarn](https://github.com/jpmens/mqttwarn) or [Home Assistant](https://www.home-assistant.io).\n\nTo connect to an MQTT broker, specify the required connection parameters in the settings (see above).\n\nCompose Updater published the following topics:\n\nTopic | Corresponding event | Example content\n--- | --- | ---\nupdate | On update run start and done | 'start' or 'done'\nupdate/composition/start | On start checking for updates for a specific Docker Composition | YAML File Path\nupdate/composition/restart/dry | On skipping composition restart due to dry-run | YAML File Path\nupdate/composition/restart/skip | On skipping composition restart due to no updated found | YAML File Path\nupdate/composition/restart/start | On restarting a composition | ```{\"composeFile\": \"/path/to/docker-compose.yml\", \"services\":[{\"name\": \"service1\", \"image\": \"image:tag\"}]}```\nupdate/composition/restart/done | On finished restarting a composition | ```{\"composeFile\": \"/path/to/docker-compose.yml\", \"services\":[{\"name\": \"service1\", \"image\": \"image:tag\"}]}```\nupdate/composition/service/built | On service's image built | ```{\"composeFile\": \"/path/to/docker-compose.yml\", \"services\":[{\"name\": \"service1\", \"image\": \"image:tag\"}]}```\nupdate/composition/service/pulled | On service's image pulled | ```{\"composeFile\": \"/path/to/docker-compose.yml\", \"services\":[{\"name\": \"service1\", \"image\": \"image:tag\"}]}```\n\n### Push notification example\nThe following [Home Assistant](https://www.home-assistant.io) configuration sends a message via Telegram whenever a Docker composition has been restarted after updating at least one image:\n\n```yaml\nautomation:\n  - alias: \"Docker Compose Update\"\n    trigger:\n      - platform: mqtt\n        topic: \"composeupdater/update/composition/restart/done\"\n        value_template: \"{{ value_json.composeFile }}\"\n    action:\n      - service: notify.telegram_bot\n        data:\n          message: \"Docker images updated: {{ trigger.payload_json.composeFile }}\"\n```\n\nRead more about how to set up the [MQTT](https://www.home-assistant.io/integrations/mqtt/) and [Telegram](https://www.home-assistant.io/integrations/telegram/) integrations in Home Assistant.\n\n## License\nGNU General Public License v3.0\n\nDocker® is a trademark of Docker, Inc.\n\nThis project is not affiliated with Docker, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirtualzone%2Fcompose-updater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvirtualzone%2Fcompose-updater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirtualzone%2Fcompose-updater/lists"}