{"id":15161785,"url":"https://github.com/redsuperbat/whaleman","last_synced_at":"2026-01-20T20:34:11.326Z","repository":{"id":65048729,"uuid":"565594573","full_name":"redsuperbat/whaleman","owner":"redsuperbat","description":"whaleman - your own whale manager","archived":false,"fork":false,"pushed_at":"2023-01-07T14:32:01.000Z","size":292,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-08T00:41:29.357Z","etag":null,"topics":["docker","docker-compose"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redsuperbat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-11-13T22:05:32.000Z","updated_at":"2022-12-23T21:02:03.000Z","dependencies_parsed_at":"2023-02-07T10:32:07.179Z","dependency_job_id":null,"html_url":"https://github.com/redsuperbat/whaleman","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/redsuperbat/whaleman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redsuperbat%2Fwhaleman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redsuperbat%2Fwhaleman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redsuperbat%2Fwhaleman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redsuperbat%2Fwhaleman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redsuperbat","download_url":"https://codeload.github.com/redsuperbat/whaleman/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redsuperbat%2Fwhaleman/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28613003,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T18:56:40.769Z","status":"ssl_error","status_checked_at":"2026-01-20T18:54:26.653Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["docker","docker-compose"],"created_at":"2024-09-27T00:45:10.211Z","updated_at":"2026-01-20T20:34:11.295Z","avatar_url":"https://github.com/redsuperbat.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"/assets/whaleman.png\" width=\"414.05px\" height=\"355.05px\" \u003e\n\u003c/p\u003e\n\n\n## 🐬 Description \nWhaleman subscribes to a number of docker-compose files in a github repo and automagically update the docker containers running when the docker-compose files change. It adheres to the gitops way, by providing an easy way to manage your docker-compose files in github.\n\nWhaleman is ment to manage itself as well as any number of docker image on a node. It's useful if you have a server at home and just want the server to update the docker cluster when the docker-compose images change.\n\n## 🛥️ Setup \n\nWhaleman can be run as a binary or as a docker image. Since it's ment to be used in conjunction with docker-compose the suggested way to run Whaleman is with docker-compose in a github repo.\n\nThe suggested way is to create a private github repo with all your compose files for a specific node, as well as the compose file for Whaleman. \n\n### Docker compose\n```yaml\nversion: \"3\"\nservices:\n  whaleman:\n    image: maxrsb/whaleman:latest\n    restart: unless-stopped\n    environment:\n      - COMPOSE_FILE_RESOURCES= \u003e-\n          \u003curl to compose file 1\u003e,\n          \u003curl to compose file 2\u003e\n      - POLLING_INTERVAL_MIN=\u003cnumber of minutes between to poll\u003e\n      # Optional GH_PAT if you host your compose files in github\n      # Whaleman can pull files from any resource so the PAT is not needed\n      - GH_PAT=\u003cpersonal access token\u003e\n    ports:\n      - 8090:8090\n    volumes:\n      - /var/run/docker.sock:/var/run/docker.sock\n      - /home/usr/whaleman:/var/lib/whaleman\n```\n\nGrab the raw url for the whaleman compose file and run an instance of Whaleman with the Whaleman compose file as the target.\n\n```shell\ndocker run -e GH_PAT=\u003cpat\u003e -e GH_COMPOSE_FILES=\u003curl to docker-compose whaleman manifest\u003e -p 8090:8090 -v /var/run/docker.sock:/var/run/docker.sock -v /home/usr/whaleman:/var/lib/whaleman maxrsb/whaleman\n```\n\nThen curl whaleman so it syncs once\n\n```shell\ncurl localhost:8090\n```\n\nWhaleman will then grab the manifest and spin up another instance of itself watching the manifest which was used to create itself with. Neat huh? 🐳\n\n## Environment variables\n\n**`COMPOSE_FILE_RESOURCES`**\n\nA comma separated list of urls which resolve to docker-compose manifests\n\n**`POLLING_INTERVAL_MIN` (optional)**\n\nA number specifying the number of minutes between polling the urls for changes. Default behavior is no polling.\n\n**`GH_PAT` (optional)**\n\nA personal access token so Whaleman can read manifests hosted in a private github repo.\n\n## 🌟 Upcoming features\n\nThe few things on my roadmap:\n- [x] Whaleman should not kill itself before restarting when changes are made to it's own manifest.\n- [ ] Whaleman should make sure what is defined in the manifests are running in docker.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredsuperbat%2Fwhaleman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredsuperbat%2Fwhaleman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredsuperbat%2Fwhaleman/lists"}