Define and run multi-container applications with Docker https://docs.docker.com/compose/
Find a file
Nicolas De Loof 34cae9461c test(e2e): lock pre_start's streamed output and tighten the foreground up scenarios
A foreground up does stream a pre_start hook's output into the session since
the hook's log stream is opened once it is started. The hook scenario had
stopped asserting it on the belief it never did; its fixture only wrote to a
file, so nothing could reach stdout. The pre_start now also prints a marker
the service never logs, asserted on stdout, and the scenario states a single
intent covering both hooks.

Also tighten the scenarios after review:
- assert a container's printed output on stdout rather than on the whole
  output, and add the state or negative checks that were missing
  (ContainerEnv after a recreation, web exited once its dependency was
  healthy, no output of the replaced container);
- the dependency timeout scenario carries the "deadline exceeded" guard of
  its detached counterpart, with a fixture aligned on it;
- drop the abort message and the useless wait from the immediate-exit
  scenario: up only returns once the application is stopped;
- rename the dry-run scenario after the others, minimize its fixture and stop
  coupling it to the dry-run end-of-output wording;
- explain the sleeps of the fixtures, and give the hook one a larger margin;
- build tag e2e only: nothing here is Unix-specific.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-10-26 10:52:50 +01:00
.github build(deps): bump docker/bake-action 2026-10-21 14:19:24 +02:00
cmd test(formatter): keep escape sequences out of the go test output 2026-10-22 09:11:41 +02:00
desktop-module build and push Docker Desktop module image on release 2026-04-10 16:12:09 +02:00
docs feat(push): deprecate --ignore-push-failures in favor of --ignore-missing 2026-10-16 18:08:20 +02:00
internal refactor(registry): read session expiry only from the stored claims 2026-10-21 17:15:36 +02:00
pkg test(e2e): lock pre_start's streamed output and tighten the foreground up scenarios 2026-10-26 10:52:50 +01:00
relay update to go1.26.10 2026-10-21 07:59:09 +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.10 2026-10-21 07:59:09 +02:00
.golangci.yml refactor(up): inject the navigation menu instead of importing cmd/formatter 2026-10-12 10:50:38 +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: remove broken CONTRIBUTING.md link 2026-10-08 08:20:34 +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.10 2026-10-21 07:59:09 +02:00
go.mod build(deps): bump secrets-engine/client to v0.2.2 2026-10-21 17:15:36 +02:00
go.sum build(deps): bump secrets-engine/client to v0.2.2 2026-10-21 17:15:36 +02:00
LICENSE
logo.png move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
Makefile build: pin gotestsum and gofumpt instead of resolving @latest 2026-10-12 11:55:20 +02:00
NOTICE move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
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.