{"id":18450062,"url":"https://github.com/quiode/compose-watcher","last_synced_at":"2026-04-13T17:03:21.495Z","repository":{"id":153245245,"uuid":"628353928","full_name":"quiode/compose-watcher","owner":"quiode","description":"Keeps docker compose files in sync with an external Git Repository","archived":false,"fork":false,"pushed_at":"2025-04-02T11:21:12.000Z","size":71,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-18T11:41:13.070Z","etag":null,"topics":["docker","docker-compose","git","sync","webhook"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quiode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"zenodo":null}},"created_at":"2023-04-15T17:25:06.000Z","updated_at":"2025-04-02T11:21:16.000Z","dependencies_parsed_at":"2025-04-16T10:35:02.332Z","dependency_job_id":null,"html_url":"https://github.com/quiode/compose-watcher","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/quiode/compose-watcher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quiode%2Fcompose-watcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quiode%2Fcompose-watcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quiode%2Fcompose-watcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quiode%2Fcompose-watcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quiode","download_url":"https://codeload.github.com/quiode/compose-watcher/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quiode%2Fcompose-watcher/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31761996,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T15:25:13.801Z","status":"ssl_error","status_checked_at":"2026-04-13T15:25:09.162Z","response_time":93,"last_error":"SSL_read: 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":["docker","docker-compose","git","sync","webhook"],"created_at":"2024-11-06T07:23:16.254Z","updated_at":"2026-04-13T17:03:21.453Z","avatar_url":"https://github.com/quiode.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Compose Watcher\n\nWatches a Git Repository containing docker-compose files and updates the running containers when new updates exist. Can be either configured using an interval, a webhook or both.\nIf no Repository exists, clones a new repository and starts all services.\nEach time the git repository gets pulled, *all* services get pulled and restarted.\n\n## Requirements\n\n- `docker compose`\n- `git`\n\n## Quick Setup\n\n### Docker Compose\n\n```text\nversion: '3.9'\n\nservices:\n  compose-watcher:\n    image: \"quiooo/compose-watcher\"\n    environment:\n      WATCHER_PORT: \"-1\"\n    volumes:\n      - /var/run/docker.sock:/var/run/docker.sock:ro\n      - /home/your-username/repo:/app/repository:rw\n    restart: always\n```\n\n## Webhook\n\n- Server Listens on Port 80, but can be customized\n- add url pointing to the docker container to your repository webhooks and listen to push events.\n- the applications runs the update checker on every webhook push\n\n## Configuration\n\n### Secrets\n\nIf the `WATCHER_WEBHOOK_SECRET` environment variable is set, the application checks the webhooks for a secret. More can be found at \u003chttps://docs.github.com/en/webhooks-and-events/webhooks/securing-your-webhooks\u003e.\n\n### .watcherignore\n\nIf a `.watcherignore` file is found next to a `docker-compose` file, the `docker-compose` file gets skipped.\n\nUsefull when hosting the compose-watcher instance in the same repository as the other compose files.\n\n### .watcher-{x}\n\nIf a file with the name `.watcher-{x}` if found, where x is a number (`.watcher-1`), the docker compose files get executed in the order of the numbers (1, 2, 3). Docker compose files wihout a `.watcher-{x}` file get executed last.\n\n### Environment Variables\n\n- `WATCHER_LOG` (default: `info`)\n  - `debug`, `info`, `warning`, `error`\n  - Set in Dockerfile\n- `WATCHER_INTERVAL` (default: `86400`)\n  - pull interval in seconds\n  - `-1` to disable interval\n- `WATCHER_PORT` (default: `80`)\n  - webhook port, -1 to disable\n  - Set in Dockerfile\n- `WATCHER_HOSTNAME` (default: `127.0.0.1`)\n  - Set in Dockerfile\n- `WATCHER_REPO_DIR` (default: `./repository`)\n  - GIT Repository Diretory\n  - Set in Dockerfile\n- `WATCHER_REMOTE_URL` (default: `''`)\n  - URL of the REMOTE, needed when no git directory exists\n- `WATCHER_WEBHOOK_SECRET` (default: `''`)\n  - if set, check webhook (improves security)\n  - see: \u003chttps://docs.github.com/en/webhooks-and-events/webhooks/securing-your-webhooks\u003e\n- `WATCHER_TELEGRAM_TOKEN` (default: `''`)\n  - token for optional telegram bot\n  - both `WATCHER_CHAT_ID` and `WATCHER_TELEGRAM_TOKEN` have to be set to enable telegram notification\n- `WATCHER_CHAT_ID` (default: `''`)\n  - chat id for optional telegram bot\n  - both `WATCHER_CHAT_ID` and `WATCHER_TELEGRAM_TOKEN` have to be set to enable telegram notification\n\n### Volumes\n\n- `/var/run/docker.sock`\n  - docker socket, required to run\n  - read only\n- `/app/repository`\n  - the git repository\n  - read and write\n- `/root/.ssh`\n  - ssh, if the repo needs ssh\n  - read only\n\n## Example Folder Structure of WATCHER_REMOTE_URL Repo\n\n```text\nproject-1\n  docker-compose.yml\nprocjet-2\n  docker-compose.yml\n  .watcher-2\nwatcher\n  docker-compose-yml\n  .watcherignore\n```\n\n## Notice\n\n### Relative Paths\n\nRelative Volume Paths mostly won't work. They will only work when the local repository path and the repository path inside the container match.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquiode%2Fcompose-watcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquiode%2Fcompose-watcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquiode%2Fcompose-watcher/lists"}