Define and run multi-container applications with Docker https://docs.docker.com/compose/
Find a file
Nicolas De Loof ac7791c2f7 fix: COMPOSE_REMOVE_ORPHANS resolves identically for every command carrying the flag
The variable had three resolution mechanisms: up read it in PreRunE
after the project's .env was injected into the process environment;
down and kill read it at cobra-tree construction time — before that
injection, so a value declared in the project's .env worked for up but
not for them; create and run never read it at all.

All five commands now resolve it through one helper, from PreRunE:
explicit flag wins, then the process environment as completed by
setEnvWithDotEnv from the local .env. create also gains the
COMPOSE_IGNORE_ORPHANS handling (its ignoreOrphans field was sent to
the API without ever being assigned) with the same conflict guard as
up.

setEnvWithDotEnv's remote-config exclusion is now documented as a
product decision, not a technical constraint: COMPOSE_* variables
exist so a local user doesn't repeat flags — they are the local user's
choice, and a remote model must not steer the CLI consuming it.

Unit tests pin the .env → process env → flag resolution order and the
remote exclusion (epic #14074, D.1 and G.3).

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-11-16 16:33:23 +01:00
.github build(deps): bump peter-evans/create-pull-request from 8.1.1 to 8.1.2 2026-11-13 15:15:02 +01:00
cmd fix: COMPOSE_REMOVE_ORPHANS resolves identically for every command carrying the flag 2026-11-16 16:33:23 +01:00
desktop-module build and push Docker Desktop module image on release 2026-04-10 16:12:09 +02:00
docs fix(docs): surface a provider-backed service's scale over its control channel 2026-11-16 10:22:24 +01:00
internal refactor(e2e): move the e2e framework and tests out of pkg/ 2026-11-16 15:21:04 +01:00
pkg refactor(e2e): move the e2e framework and tests out of pkg/ 2026-11-16 15:21:04 +01:00
relay fix(relay): build the relay image like the compose binary 2026-11-12 19:07:46 +01:00
.dockerignore Better sandboxed workflow and enhanced cross compilation 2022-08-12 15:05:58 +02:00
.gitattributes Removed test requiring linux containers 2020-06-11 12:58:58 +02:00
.gitignore refactor(e2e): move the e2e framework and tests out of pkg/ 2026-11-16 15:21:04 +01:00
.go-version Update to go1.27.4 2026-11-10 22:40:32 +01:00
.golangci.yml refactor(e2e): move the e2e framework and tests out of pkg/ 2026-11-16 15:21:04 +01:00
AGENTS.md docs(agents): add an architecture map of the non-guessable facts 2026-11-16 16:10:47 +01: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 refactor(e2e): move the e2e framework and tests out of pkg/ 2026-11-16 15:21:04 +01: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.27.4 2026-11-10 22:40:32 +01:00
go.mod build(deps): bump github.com/docker/cli to v29.10.0 2026-11-16 15:34:37 +01:00
go.sum build(deps): bump github.com/docker/cli to v29.10.0 2026-11-16 15:34:37 +01:00
LICENSE Add LICENSE and NOTICE files 2020-08-17 10:20:49 +02:00
logo.png move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
Makefile refactor(e2e): move the e2e framework and tests out of pkg/ 2026-11-16 15:21:04 +01: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.