Define and run multi-container applications with Docker https://docs.docker.com/compose/
Find a file
Nicolas De Loof 0632f222f6 test(e2e): declarative Scenario layer, image-identity tests as demonstrator
Introduce a small declarative layer over the e2e framework so a test
reads as its intent: an inline compose.yaml, a sequence of steps
(command + expected observables), and nothing else. The framework owns
project naming (derived from the test name), cleanup, and failure
reporting: on the first unmet expectation the test fails with a step
transcript, the failing command output, the project's container state,
the engine events since the scenario started and the container logs.

Checks observe real state (container IDs across steps, labels, image
manifest platform) instead of grepping the progress writer output,
which stays available as an explicit last-resort check.

The e2e tests introduced by #14041 are converted as a demonstrator;
their dedicated fixture files are inlined in the scenarios and removed.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-08-18 16:49:56 +02:00
.github build(deps): bump github/codeql-action/upload-sarif 2026-08-13 15:26:59 +02:00
cmd refactor: extract RootCommand's PersistentPreRunE concerns 2026-08-18 13:37:48 +02:00
desktop-module build and push Docker Desktop module image on release 2026-04-10 16:12:09 +02:00
docs Generate docs with make docs 2026-06-29 20:56:31 +02:00
internal fix(oci): fetch artifact layers from blobs endpoint, not via Resolve 2026-08-03 14:56:34 +02:00
pkg test(e2e): declarative Scenario layer, image-identity tests as demonstrator 2026-08-18 16:49:56 +02:00
.dockerignore
.gitattributes
.gitignore distinguish event (short) status text and details 2025-11-04 10:18:55 +01:00
.go-version bump golang to version 1.26.6 2026-08-14 14:20:41 +02:00
.golangci.yml lint: explicitly disable gocyclo so it doesn't sneak back in 2026-08-18 10:42:37 +02:00
AGENTS.md docs: require dated AI_AGENT_DISCLOSURE.md, drop committed copy 2026-07-28 10:18:38 +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
CONTRIBUTING.md Update link in stats --help output 2025-02-04 18:12:17 +01:00
docker-bake.hcl build and push Docker Desktop module image on release 2026-04-10 16:12:09 +02:00
Dockerfile bump golang to version 1.26.6 2026-08-14 14:20:41 +02:00
go.mod build(deps): bump google.golang.org/grpc from 1.82.1 to 1.83.0 2026-08-13 16:35:41 +02:00
go.sum build(deps): bump google.golang.org/grpc from 1.82.1 to 1.83.0 2026-08-13 16:35:41 +02:00
LICENSE
logo.png
Makefile ci: raise e2e go-test timeout to 20m 2026-08-17 11:09:19 +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.