Need help with compose?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

docker
24.0K Stars 4.0K Forks Apache License 2.0 3.0K Commits 646 Opened issues

Description

Define and run multi-container applications with Docker

Services available

!
?

Need anything else?

Contributors list

Docker Compose v2

Actions Status

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 rewriten 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 for installing 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 to make 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.