About this project

Docker Compose is a tool for running multi-container applications on Docker, defined using the Compose file format. A Compose file describes how one or more containers that make up an application are configured. Once a Compose file exists, the application can be created and started with a single command: docker compose up. Where to get it - Windows and macOS: Docker Compose is included in Docker Desktop. - Linux: binaries can be downloaded from the repository's release page. Rename the relevant binary for your OS to docker-compose and copy it to $HOME/.docker/cli-plugins, or install it system-wide in one of these folders: /usr/local/lib/docker/cli-plugins or /usr/local/libexec/docker/cli-plugins; /usr/lib/docker/cli-plugins or /usr/libexec/docker/cli-plugins. The downloaded file may need to be made executable with chmod +x. Quick start Using Docker Compose is described as a three-step process: 1. Define the app's environment with a Dockerfile so it can be reproduced anywhere. 2. Define the services that make up the app in compose.yaml so they can run together in an isolated environment. 3. Run docker compose up, and Compose starts and runs the entire app. An example Compose file defines a web service built from the current directory, exposing port 5000 and mounting the code directory, plus a redis service using the redis image. Notes The README notes that Docker Swarm relied on the legacy compose file format and did not adopt the compose specification, so it misses recent enhancements in compose syntax; after acquisition by Mirantis, Swarm is not maintained by Docker Inc, and some Docker Compose features are not accessible to swarm users. Contributing and legacy Contributing documentation is provided in the repository, and issues can be reported on the issue tracker. The Python version of Compose is available under the v1 branch.