Define and run multi-container applications with Docker https://docs.docker.com/compose/
Find a file
Nicolas De Loof b5cf514b29 fix(provider): clean up stale relay and guard start/restart against it
A provider that stops publishing endpoints on a later `up` left its
previously created relay running: deployRelay was only evaluated when
endpoints were non-empty, so a zero-endpoint up fell through with no
cleanup. The generic reconciler is no help either — it returns early
for any service.Provider != nil, before the recreate logic that would
otherwise catch this. runPlugin now removes any existing relay when a
provider publishes no endpoint on an up, whether it never did or
stopped doing so since a previous run.

Separately, startServiceContainer and restartContainer had no
relay-awareness at all, unlike exec/cp which already refuse to target
one via checkRelayTarget. A relay is a shell-less, FROM-scratch binary
standing in for the service on the network: it has no filesystem or
process for secrets/configs injection or PreStart/PostStart/PreStop
hooks to act on. Nothing in the compose-spec schema forbids declaring
secrets, configs or hooks on a provider: service, so this was reachable
in practice, not just in theory. Both now skip those steps for a relay
container while still starting/restarting the container itself
normally.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-09-17 17:51:23 +02:00
.github ci: lint, vet and test relay/ as its own module 2026-09-17 09:23:54 +02:00
cmd fix(port): preserve tie order for dual-stack port publishers 2026-09-14 10:48:03 +02:00
desktop-module build and push Docker Desktop module image on release 2026-04-10 16:12:09 +02:00
docs docs: dedicated section for compose-native addressing via publish-endpoint 2026-09-16 17:03:23 +02:00
internal fix(publish): report OCI fallback as a bool, not the OCI version 2026-09-15 14:54:03 +02:00
pkg fix(provider): clean up stale relay and guard start/restart against it 2026-09-17 17:51:23 +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 test(e2e): gate the e2e suite behind the build tag the docs already promise 2026-08-27 11:02:07 +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(contributing): legibility guidelines — comments state behavior, not history 2026-08-27 11:17:14 +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): github.com/docker/cli v29.8.0 2026-09-15 11:56:34 +02:00
go.sum build(deps): github.com/docker/cli v29.8.0 2026-09-15 11:56:34 +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.