{"id":21078793,"url":"https://github.com/timokoessler/docker-deploy-api","last_synced_at":"2025-06-24T08:02:39.065Z","repository":{"id":213392158,"uuid":"733932500","full_name":"timokoessler/docker-deploy-api","owner":"timokoessler","description":"An easy-to-use API for deploying Docker containers","archived":false,"fork":false,"pushed_at":"2024-12-09T08:43:42.000Z","size":637,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-23T07:16:13.493Z","etag":null,"topics":["api","container","containerization","deploy","deployment","docker"],"latest_commit_sha":null,"homepage":"https://deploy-api.tkoessler.de","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/timokoessler.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-12-20T13:14:56.000Z","updated_at":"2025-05-27T16:13:09.000Z","dependencies_parsed_at":"2024-05-18T12:40:18.789Z","dependency_job_id":"5dd81ba3-fc81-4df1-97c2-958aedd84f61","html_url":"https://github.com/timokoessler/docker-deploy-api","commit_stats":null,"previous_names":["timokoessler/docker-deploy-api"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/timokoessler/docker-deploy-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timokoessler%2Fdocker-deploy-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timokoessler%2Fdocker-deploy-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timokoessler%2Fdocker-deploy-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timokoessler%2Fdocker-deploy-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timokoessler","download_url":"https://codeload.github.com/timokoessler/docker-deploy-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timokoessler%2Fdocker-deploy-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261632033,"owners_count":23187268,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["api","container","containerization","deploy","deployment","docker"],"created_at":"2024-11-19T19:42:22.488Z","updated_at":"2025-06-24T08:02:39.040Z","avatar_url":"https://github.com/timokoessler.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🐳 Docker Deploy API\n\n[![license](https://badgen.net/docker/pulls/timokoessler/docker-deploy-api)](https://hub.docker.com/r/timokoessler/docker-deploy-api)\n[![license](https://badgen.net/github/license/timokoessler/docker-deploy-api)](https://github.com/timokoessler/docker-deploy-api/blob/main/LICENSE)\n[![CodeFactor](https://www.codefactor.io/repository/github/timokoessler/docker-deploy-api/badge)](https://www.codefactor.io/repository/github/timokoessler/docker-deploy-api)\n[![codecov](https://codecov.io/gh/timokoessler/docker-deploy-api/graph/badge.svg?token=VYS4DJZOP3)](https://codecov.io/gh/timokoessler/docker-deploy-api)\n\nAn easy-to-use API for deploying Docker containers to a server.\n\nLet's say you build a Docker image for your application using a CI/CD pipeline and upload the image to a Docker registry.\nBut how do you update the running containers on your servers with the new image? You can use Docker Deploy API to do that.\n\n## Features\n\n- Pull new image and recreate container, or only recreate or restart a container\n- Update multiple containers at once 🔄️\n- Clean up old images 🧹\n- Works with private Docker registries 🔒\n- No need to give your CI/CD pipeline SSH access to your servers 🛡️\n- Works without any database\n- Supports any CI/CD pipeline, e.g. GitHub Actions, GitLab CI, etc.\n\n## Installation 🚀\n\n\u003e [!TIP]\n\u003e You can find all information about the installation, configuration and usage in the [documentation](https://deploy-api.tkoessler.de).\n\nThe easiest way to set up Docker Deploy API is to use the provied [docker-compose](https://github.com/timokoessler/docker-deploy-api/blob/main/docker-compose.yml) file.\n\n## How it works\n\nDocker Deploy API is a HTTP API that you can call from your CI/CD pipeline. The request contains a deploy token that you can generate using the CLI tool.\nThis token is used to authenticate the request and contains the configuration for the deployment.\nFor convenience, there is a bash script that you can use in your CI/CD pipeline for sending the request.\n\n## GitHub Actions example\n\nThe following example shows how to use Docker Deploy API in a GitHub Actions workflow using the helper bash script that is hosted by every instance of Docker Deploy API.\n\n```yaml\n- name: Deploy 🚀\n  run: curl -sSL \"https://deploy.example.com/s\" | bash -s -- \"${{ secrets.DEPLOY_TOKEN }}\"\n```\n\nIn the [documentation](https://deploy-api.tkoessler.de) you can find examples for other CI/CD pipelines. You can also start the deployment by simply calling the HTTP API with any tool of your choice.\n\n## Contact\n\nIf a public GitHub issue or discussion is not the right choice for your concern, you can contact me directly:\n\n- E-Mail: [info@timokoessler.de](mailto:info@timokoessler.de)\n\n## License\n\n© [Timo Kössler](https://timokoessler.de) 2024  \nReleased under the [MIT license](https://github.com/timokoessler/docker-deploy-api/blob/main/LICENSE)\n\n\u003csub\u003e\u003csup\u003eDocker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein. The whale logo is licensed under the MIT license - © Microsoft Corporation (fluentui-emoji).\u003c/sup\u003e\u003c/sub\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimokoessler%2Fdocker-deploy-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimokoessler%2Fdocker-deploy-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimokoessler%2Fdocker-deploy-api/lists"}