Home

Welcome to the Docker Compose Webhook Wiki!

What is Docker Compose Webhook?

Docker Compose Webhook is a lightweight GitOps tool that automatically deploys and updates Docker Compose services when a change is pushed to a Git repository.

The application listens for incoming HTTP requests (Webhooks) sent from a Git repository and runs an automatic Docker Compose deployment for that repository when triggered.

Important

This project currently is still in early development.
Feel free to share your ideas and opinions with me. :)

Features

• Simple setup: Docker Compose Webhook is easy to set up and use.
• Secure: The application runs in with minimal (distroless) image with minimal permissions and supports webhook authentication.
• Flexible: The deployments can be configured using a deployment configuration file.
• Customizable: The application can be configured using environment variables.
• Lightweight: The application is built with Go and has a small footprint.

Getting Started

1. Quickstart - Learn how to run the application.
2. App Settings - Configure the application settings.
3. Deploy Settings - Configure the Docker Compose deployment in your repositories.

Supported Git Providers

• GitHub
• GitLab (planned)
• Gitea (planned)
• Bitbucket (planned)

Releases and Changelog

See the releases page for release notes and changelogs.

Image

You can find the Docker image on GitHub Container Registry.

docker pull ghcr.io/kimdre/docker-compose-webhook:latest

Contributing

If you have any suggestions, feature requests, or want to contribute, feel free to open an issue or a pull request.