README
¶
doco-cd - Docker Compose Continuous Deployment
GitOps for Docker Compose
Doco-CD is a lightweight, declarative GitOps continuous delivery tool that automatically deploys and updates Docker Compose projects/services and Swarm stacks using polling and webhooks.
You can think of it as a simple Portainer or ArgoCD alternative for Docker.
Documentation
You can find the documentation at doco.cd.
Features
- Easy to set up and use with minimal configuration.
- Runs with a minimal (distroless) image with tiny RAM and CPU requirements.
- Supports various Git providers.
- Deploy via webhooks and/or polling.
- Supports both Docker Compose projects and Swarm stacks in Swarm mode.
- Supports OCI artifacts and Git repositories for deployments.
- Supports various external secret providers and encryption with SOPS.
- Deploy to multiple Docker hosts with Docker Contexts.
- Control when deployments may happen with timezone-aware sync windows and cron-scheduled polling.
- Provides notifications and Prometheus metrics for monitoring.
- Job Scheduling, Pre/Post-deployment scripts, REST API and MCP Server for advanced automation and integrations.
Community
- Ask questions or discuss ideas on GitHub Discussions
- Report bugs or suggest features by opening an issue
Contributing
Contributions are welcome! Please see the contributing guidelines for more information.
Support the Project
If you would like to support the development of Doco-CD, please consider becoming a sponsor on GitHub Sponsors.
Doco-CD is proudly supported by
Star History
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
deploy-schema
command
Package main generates the deployment configuration schema used by editors.
|
Package main generates the deployment configuration schema used by editors. |
|
doco-cd
command
|
|
|
healthcheck
command
Command healthcheck checks the health endpoint of the doco-cd server running in the same container.
|
Command healthcheck checks the health endpoint of the doco-cd server running in the same container. |
|
metrics-docs
command
Package main generates the Markdown metrics reference used by the Zensical metrics endpoint page.
|
Package main generates the Markdown metrics reference used by the Zensical metrics endpoint page. |
|
internal
|
|
|
certrotation
Package certrotation implements a background watcher that automatically rotates certificates issued through rotation-capable external secret providers (currently only OpenBao PKI roles, see internal/secretprovider/openbao) before they expire.
|
Package certrotation implements a background watcher that automatically rotates certificates issued through rotation-capable external secret providers (currently only OpenBao PKI roles, see internal/secretprovider/openbao) before they expire. |
|
common/cronexpr
Package cronexpr parses the cron expressions shared by job scheduling, poll schedules and sync windows, so all of them accept the same syntax.
|
Package cronexpr parses the cron expressions shared by job scheduling, poll schedules and sync windows, so all of them accept the same syntax. |
|
common/defaults
Package defaults applies struct-tag defaults to Go structs.
|
Package defaults applies struct-tag defaults to Go structs. |
|
common/types/clone
Package clone provides helpers for copying reference types.
|
Package clone provides helpers for copying reference types. |
|
common/validation
Package validation provides struct-tag validation helpers and custom validator registration for internal config types.
|
Package validation provides struct-tag validation helpers and custom validator registration for internal config types. |
|
gc
Package gc implements artifact garbage collection: periodically removing published source artifacts (internal/source/store) that are no longer referenced by any deployed stack or service, are past their retention window, and are not currently being used by an in-progress deployment.
|
Package gc implements artifact garbage collection: periodically removing published source artifacts (internal/source/store) that are no longer referenced by any deployed stack or service, are past their retention window, and are not currently being used by an in-progress deployment. |
|
migration
Package migration converts legacy repository checkouts to the current mirror-and-artifact layout during startup.
|
Package migration converts legacy repository checkouts to the current mirror-and-artifact layout during startup. |
|
source
Package source resolves a deployment's source, either a Git repository or an OCI artifact, into a ready-to-deploy local checkout.
|
Package source resolves a deployment's source, either a Git repository or an OCI artifact, into a ready-to-deploy local checkout. |
|
source/store
GitStore implements Store on top of a Git repository.
|
GitStore implements Store on top of a Git repository. |
|
syncwindow
Package syncwindow implements sync windows: operator-defined, timezone-aware allow and deny windows that decide whether a deployment may change a stack at a given time.
|
Package syncwindow implements sync windows: operator-defined, timezone-aware allow and deny windows that decide whether a deployment may change a stack at a given time. |
Click to show internal directories.
Click to hide internal directories.