No Description

Guillaume Lours ce3700d334 keep the platform defined, in priority, via DOCKER_DEFAULT_PLATFORM or the service.plaform one if no build platforms provided 3 years ago
.github 8891d9e2b5 Streamline GHA workflow 3 years ago
cmd 61845dd781 logs: filter to services from current Compose file (#9811) 3 years ago
docs a226fe9daf Update docs for new `compose kill` `--remove-orphans` option 3 years ago
internal 88ba4599b2 move ACI/ECS -specific const to related packages 4 years ago
packaging 2aea82a7c6 packaging: Add EULA 5 years ago
pkg ce3700d334 keep the platform defined, in priority, via DOCKER_DEFAULT_PLATFORM or the service.plaform one if no build platforms provided 3 years ago
.dockerignore 5ec20296e4 Better sandboxed workflow and enhanced cross compilation 3 years ago
.gitattributes 93984f8c68 Removed test requiring linux containers 5 years ago
.gitignore 5ec20296e4 Better sandboxed workflow and enhanced cross compilation 3 years ago
.golangci.yml f72a604cbd ci: upgrade golangci-lint 3 years ago
BUILDING.md 5ec20296e4 Better sandboxed workflow and enhanced cross compilation 3 years ago
CONTRIBUTING.md d789b2e426 Improve descriptions about tests in CONTRIBUTING.md 3 years ago
Dockerfile f72a604cbd ci: upgrade golangci-lint 3 years ago
LICENSE d7d9bb28bb Add LICENSE and NOTICE files 5 years ago
MAINTAINERS fc827f295b Fix the maintainers array in MAINTAINERS 4 years ago
Makefile 0dc64723c9 Restore `-s` in `uname` OS detection logic in `Makefile` 3 years ago
NOTICE 1ae9b3cb5d move compose-cli code into docker/compose/v2 4 years ago
README.md e413c2137a Update README.md 3 years ago
docker-bake.hcl e81168197a ci: upgrade to Go 1.19.1 3 years ago
go.mod ddc4896b10 update compose-go version to v1.5.1 3 years ago
go.sum ddc4896b10 update compose-go version to v1.5.1 3 years ago
logo.png 1ae9b3cb5d move compose-cli code into docker/compose/v2 4 years ago

README.md

Docker Compose v2

GitHub release PkgGoDev Build Status Go Report Card

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 the 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.

About update and backward compatibility

Docker Compose V2 is a major version bump release of Docker Compose. It has been completely rewritten from scratch in Golang (V1 was in Python). The installation instructions for Compose V2 differ from V1. V2 is not a standalone binary anymore, and installation scripts will have to be adjusted. Some commands are different.

For a smooth transition from legacy docker-compose 1.xx, please consider installing compose-switch to translate docker-compose ... commands into Compose V2's docker compose ..... Also check V2's --compatibility flag.

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 basically 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 docker-compose.yml 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.