Define and run multi-container applications with Docker
Go to file
Vedant Koditkar 1d4cb32001
Add support to push images quietly via compose cli
Signed-off-by: Vedant Koditkar <vedant.koditkar@outlook.com>
2022-10-11 15:19:23 -05:00
.github ci: update docs repo path 2022-09-29 13:09:25 -04:00
cmd Add support to push images quietly via compose cli 2022-10-11 15:19:23 -05:00
docs Update docs for new `compose kill` `--remove-orphans` option 2022-08-19 04:29:51 +02:00
e2e Bump e2e module deps 2022-10-10 15:23:04 +02:00
internal move ACI/ECS -specific const to related packages 2021-08-31 16:05:32 +02:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
pkg Add support to push images quietly via compose cli 2022-10-11 15:19:23 -05: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 Better sandboxed workflow and enhanced cross compilation 2022-08-12 15:05:58 +02:00
.golangci.yml ci: upgrade golangci-lint 2022-09-06 17:59:11 -04:00
BUILDING.md Better sandboxed workflow and enhanced cross compilation 2022-08-12 15:05:58 +02:00
CONTRIBUTING.md Improve descriptions about tests in CONTRIBUTING.md 2022-07-30 17:18:39 +09:00
Dockerfile Update to go 1.19.2 to address CVE-2022-2879, CVE-2022-2880, CVE-2022-41715 2022-10-04 21:27:06 +02:00
LICENSE Add LICENSE and NOTICE files 2020-08-17 10:20:49 +02:00
MAINTAINERS Fix the maintainers array in MAINTAINERS 2021-11-02 22:39:51 +01:00
Makefile Add Makefile, buildx target to ensure root and e2e go.mod are kept in sync 2022-09-27 02:35:57 +02:00
NOTICE move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
README.md Update README.md 2022-09-11 17:28:35 +03:00
docker-bake.hcl Update to go 1.19.2 to address CVE-2022-2879, CVE-2022-2880, CVE-2022-41715 2022-10-04 21:27:06 +02:00
go.mod build(deps): bump gotest.tools/v3 from 3.3.0 to 3.4.0 2022-10-10 09:33:24 +00:00
go.sum build(deps): bump gotest.tools/v3 from 3.3.0 to 3.4.0 2022-10-10 09:33:24 +00:00
logo.png move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
verify-go-modules.sh Adjust modules sync validating script 2022-09-27 15:47:00 +02:00

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.