Define and run multi-container applications with Docker https://docs.docker.com/compose/
Find a file
Nicolas De Loof eb0fb65e0c docs(provider), e2e: image distribution documented and exercised
extension.md gains the Image distribution section: invocation contract
(--image/--digest/--created/--source/--policy), the get-image request
and its chunked image-stream answer (zero-chunk terminated, stdin
exclusivity and drain-before-next-answer contract), the two-branch
decision guidance (digest as identity, created as ordering fallback,
reproducible builds caveat), and the support-by-presence metadata
convention is now stated as the general rule. The example provider
implements pull end to end — request, stock chunked reader, hash
recorded at PROVIDER_PULL_MARKER — and the e2e scenario locks the
whole path: up builds the service image and streams it to the provider
under the local verdict, compose pull re-invokes it under the
freshness contract.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-10-02 17:35:20 +02:00
.github build(deps): bump github/codeql-action/upload-sarif 2026-10-01 18:29:51 +02:00
cmd chore: remove duplicate 'publish' registration under 'alpha' 2026-09-30 14:47:12 +02:00
desktop-module build and push Docker Desktop module image on release 2026-04-10 16:12:09 +02:00
docs docs(provider), e2e: image distribution documented and exercised 2026-10-02 17:35:20 +02:00
internal fix: share --parallel budget across down's ops and up's log-attach 2026-10-01 16:02:14 +02:00
pkg docs(provider), e2e: image distribution documented and exercised 2026-10-02 17:35:20 +02:00
relay ci: lint, vet and test relay/ as its own module 2026-09-17 09:23:54 +02:00
.dockerignore Better sandboxed workflow and enhanced cross compilation 2022-08-12 15:05:58 +02:00
.gitattributes
.gitignore distinguish event (short) status text and details 2025-11-04 10:18:55 +01:00
.go-version Update to go1.26.8 2026-09-02 18:44:40 +02:00
.golangci.yml golangci-lint: enable perfsprint linter 2026-09-10 10:25:34 +02:00
AGENTS.md docs(ai-policy): adopt the centralized moby/.github AI usage policy 2026-09-29 15:46:11 +02:00
AI_POLICY.md docs(ai-policy): adopt the centralized moby/.github AI usage policy 2026-09-29 15:46:11 +02:00
BUILDING.md Add go as a prerequesite in build instructions 2025-08-06 15:27:09 +02:00
CLAUDE.md docs: adopt AGENTS.md standard, symlink CLAUDE.md to it 2026-07-21 17:43:06 +02:00
codecov.yml ci: merge Go coverage reports before upload (#10666) 2023-06-08 14:58:21 -04:00
CONTRIBUTING.md docs(ai-policy): adopt the centralized moby/.github AI usage policy 2026-09-29 15:46:11 +02:00
docker-bake.hcl ci: lint, vet and test relay/ as its own module 2026-09-17 09:23:54 +02:00
Dockerfile Update to go1.26.8 2026-09-02 18:44:40 +02:00
go.mod build(deps): bump moby/moby and containerd/containerd/v2 2026-10-02 08:59:09 +02:00
go.sum build(deps): bump moby/moby and containerd/containerd/v2 2026-10-02 08:59:09 +02:00
LICENSE
logo.png
Makefile ci: lint, vet and test relay/ as its own module 2026-09-17 09:23:54 +02:00
NOTICE
README.md README: remove Go Report Card badge 2026-07-16 11:39:14 +02:00

Table of Contents

Docker Compose

GitHub release PkgGoDev Build Status Codecov OpenSSF Scorecard Docker Compose

Docker Compose is a tool for running multi-container applications on Docker defined using the Compose file format. A Compose file is used to define how one or more containers that make up your application are configured. Once you have a Compose file, you can create and start your application with a single command: docker compose up.

Note

Docker Swarm used to rely on the legacy compose file format but did not adopt the compose specification so is missing some of the recent enhancements in the compose syntax. After acquisition by Mirantis swarm isn't maintained by Docker Inc, and as such some Docker Compose features aren't accessible to swarm users.

Where to get Docker Compose

Windows and macOS

Docker Compose is included in Docker Desktop for Windows and macOS.

Linux

You can download Docker Compose binaries from the release page on this repository.

Rename the relevant binary for your OS to docker-compose and copy it to $HOME/.docker/cli-plugins

Or copy it into one of these folders to install it system-wide:

  • /usr/local/lib/docker/cli-plugins OR /usr/local/libexec/docker/cli-plugins
  • /usr/lib/docker/cli-plugins OR /usr/libexec/docker/cli-plugins

(might require making the downloaded file executable with chmod +x)

Quick Start

Using Docker Compose is a three-step process:

  1. Define your app's environment with a Dockerfile so it can be reproduced anywhere.
  2. Define the services that make up your app in compose.yaml so they can be run together in an isolated environment.
  3. Lastly, run docker compose up and Compose will start and run your entire app.

A Compose file looks like this:

services:
  web:
    build: .
    ports:
      - "5000:5000"
    volumes:
      - .:/code
  redis:
    image: redis

Contributing

Want to help develop Docker Compose? Check out our contributing documentation.

If you find an issue, please report it on the issue tracker.

Legacy

The Python version of Compose is available under the v1 branch.