[{"_1":2,"_160":-5,"_161":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_139":140},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_128":-5,"_129":11,"_130":21,"_131":11,"_132":-5,"_133":11,"_134":-5,"_135":136,"_137":91,"_138":-7},"canonicalUrl","https://hub.docker.com/r/zackprod/puller-dockerhub/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","zackprod","reponame","puller-dockerhub","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2023-05-27T18:10:20.57353Z","description","","is_private","last_updated","2025-04-25T10:14:47.443725Z","last_modified","2025-04-25T10:15:11.539207Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",443,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

\n $\"PULLER$ \n

PULLER DOCKERHUB

\n A lightweight HTTP API to automate CI/CD using Docker Hub .\n

\n \n

\n\n---\n\n## 📋 Table of Contents\n\n- [🚀 What Is Puller?](#-what-is-puller) \n- [✨ Key Features](#-key-features) \n- [🚀 Quick Start](#-quick-start) \n- [⚙️ Configuration](#️-configuration) \n - [Environment Variables](#environment-variables) \n - [Compose Setup](#compose-setup) \n- [📖 Usage](#-usage) \n - [Trigger via HTTP](#trigger-via-http) \n - [🔗 Integrate with Docker Hub](#-integrate-with-docker-hub) \n- [🛠️ Health & Logging](#️-health--logging) \n- [🐞 Troubleshooting](#-troubleshooting) \n- [🤝 Contributing](#-contributing) \n- [📄 License](#-license) \n- [📬 Contact](#-contact) \n\n---\n\n## 🚀 What Is Puller?\n\n**Puller** is a minimal HTTP API service that listens for Docker Hub webhook payloads and, pulls and redeploys a specified container.\n\nIt's designed to be lightweight, easy to configure, and suitable for use in CI/CD pipelines.\n\nThis lets you automatically redeploy containers whenever you push a new image tag to Docker Hub, without manual intervention.\n\n---\n\n## ✨ Key Features\n\n- **Automatic Pull & Deploy** \n Executes `docker pull` and `docker-compose up` on-demand. \n- **Webhook Listener** \n Accepts Docker Hub webhook POSTs and parses the payload for image and tag. \n- **Configurable** \n Control ports, retry attempts, and service names via environment variables. \n- **Lightweight** \n Small memory footprint and simple dependencies. \n- **Secure by Default** \n Runs with read-only Docker socket and minimal privileges.\n\n---\n\n## 🚀 Quick Start\n\n1. **Clone & Deploy** \n ```bash\n git clone https://github.com/ehzack/puller-dockerhub.git\n cd puller-dockerhub\n docker-compose up -d\n ```\n\n2. **Configure Webhook on Docker Hub** \n See [Integrate with Docker Hub](#-integrate-with-docker-hub) below.\n\n3. **Push a New Tag** \n ```bash\n docker tag my-app:latest youruser/my-app:release-1.0\n docker push youruser/my-app:release-1.0\n ```\n Puller will automatically pull and redeploy your container.\n\n---\n\n## ⚙️ Configuration\n\n### Environment Variables\n\n| Variable | Default | Description |\n| ------------------ | ------- | ---------------------------------------------------- |\n| `SERVER_PORT` | `4999` | HTTP port on which Puller listens. |\n| `RETRY_COUNT` | `3` | Number of times to retry a failed `docker pull`. |\n| `COMPOSE_SERVICE` | none | (Optional) Service name for `docker-compose up`. |\n| `LOG_LEVEL` | `info` | Logging level: `debug`, `info`, `warn`, `error`. |\n| `LOG_MAX_SIZE` | `3` | Maximum size of log files in MB. |\n| `LOG_MAX_FILES` | `3` | Maximum number of log files to retain. |\n\n### Compose Setup\n\n```yaml\nversion: \"3.8\"\nservices:\n puller:\n image: ehzack/puller-dockerhub:latest\n restart: always\n ports:\n - \"${SERVER_PORT:-4999}:4999\"\n volumes:\n - /var/run/docker.sock:/var/run/docker.sock:ro\n environment:\n SERVER_PORT: 4999\n LOG_MAX_SIZE: 3 # in MB\n LOG_MAX_FILES: 3\n```\n\n---\n\n## 📖 Usage\n\n### Trigger via HTTP\n\nYou can manually trigger a pull & deploy:\n\n```bash\ncurl -X POST \"http://:/trigger\" -H \"Content-Type: application/json\" -d '{\n \"image\": \"youruser/my-app:latest\",\n \"composeService\": \"web\"\n }'\n```\n\n- **`image`**: Full image reference (`:`). \n- **`composeService`**: (Optional) Overrides `COMPOSE_SERVICE` env var.\n\n### 🔗 Integrate with Docker Hub\n\n1. **Add Webhook** \n - Go to your Docker Hub repo ▶︎ **Settings** ▶︎ **Webhooks**. \n - Click **Add Webhook**, set the URL to: \n ```\n http://:/trigger?path=$path$&container_name=$container_name\n ```\nQuery Parameters:\n- **$path**: The location of your docker-compose.yml file (Example: /home/user/app/docker-compose.yml)\n- **$container_name**: The name of the container you want to restart (Example: my-web-app)\n\n\nExample URL:\n- http://localhost:4999/trigger?path=/home/user/app/docker-compose.yml&container_name=web-app\n \n\n\n2. **Configure Compose Service** \n Ensure your `docker-compose.yml` defines the service you want to restart:\n\n ```yaml\n version: \"3.8\"\n services:\n web:\n image: youruser/my-app:latest\n # ...\n ```\n\n3. **Push New Image** \n Every `docker push` will send a webhook to Puller. It will:\n 1. Parse the payload for `repository` and `push_data.tag`. \n 2. Run `docker pull youruser/my-app:`. \n 3. Execute `docker-compose up -d web`.\n\n---\n\n## 🛠️ Health & Logging\n\n- **Health Endpoint**: \n `GET /health` returns `200 OK` if service is healthy. \n- **Logs**: \n Stream logs via Docker: \n ```bash\n docker logs -f puller-dockerhub_puller_1\n ```\n\n---\n\n## 🐞 Troubleshooting\n\n- **Socket Permission Denied** \n ```bash\n sudo chmod 660 /var/run/docker.sock\n sudo usermod -aG docker $(whoami)\n ```\n- **Unexpected Payload** \n Ensure Docker Hub webhook is configured with **application/json** content type. \n- **Service Not Restarting** \n Confirm `COMPOSE_SERVICE` matches your service name in `docker-compose.yml`.\n\n---\n\n## 🤝 Contributing\n\nWe welcome your improvements and bug fixes! Please see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n---\n\n## 📄 License\n\nThis project is licensed under the **MIT License**. See [LICENSE](LICENSE).\n\n---\n\n## 📬 Contact\n\n- **Author**: Zack \n- **GitHub**: [ehzack/puller-dockerhub](https://github.com/ehzack/puller-dockerhub) \n\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",1201018598,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},"content_type","creator",9720378,"digest","sha256:20663aad89b0e3cd17bf95241c42ee4acbaf1cec52caab49c006efd06fc12872","full_size",164452499,"id",446693231,"images",[103],{"_104":105,"_95":96,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":98,"_63":66,"_116":-5},"architecture","amd64","features","last_pulled","2026-10-09T15:43:16.99550413Z","last_pushed","2025-04-25T10:14:46.019133495Z","os","linux","os_features","os_version","size","variant","2025-04-25T10:14:46.353992Z","last_updater","last_updater_username","media_type","latest","repository",20125493,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":141,"_148":149,"_135":158,"_159":11},{"_40":142,"_42":143,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":144,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":145,"_79":11,"_80":147,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":146},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_150":64,"_151":-5,"_152":-5,"_153":154},"count","next","previous","results",[155],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":156,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},[157],{"_104":105,"_95":96,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":98,"_63":66,"_116":-5},[],"canDeleteTags","actionData","errors"]

zackprod/puller-dockerhub

Tags for zackprod/puller-dockerhub