Define and run multi-container applications with Docker
Go to file
Milas Bowman 3b0742fd57
watch: batch & de-duplicate file events (#10865)
Adjust the debouncing logic so that it applies to all inbound file
events, regardless of whether they match a sync or rebuild rule.

When the batch is flushed out, if any event for the service is a
rebuild event, then the service is rebuilt and all sync events for
the batch are ignored. If _all_ events in the batch are sync events,
then a sync is triggered, passing the entire batch at once. This
provides a substantial performance win for the new `tar`-based
implementation, as it can efficiently transfer the changes in bulk.

Additionally, this helps with jitter, e.g. it's not uncommon for
there to be double-writes in quick succession to a file, so even if
there's not many files being modified at once, it can still prevent
some unnecessary transfers.

Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2023-08-03 14:53:02 -04:00
.github use main branch of Docker Desktop repo to trigger remote workflow 2023-06-20 12:14:08 +02:00
cmd build: do not attempt to push unnamed service images 2023-07-19 09:58:37 +02:00
docs deps: bump docker/cli-docs-tool to v0.6.0 2023-07-10 12:23:48 +02:00
e2e test: temporarily disable an exit-code-from Cucumber test case (#10875) 2023-08-03 14:49:59 -04:00
internal watch: batch & de-duplicate file events (#10865) 2023-08-03 14:53:02 -04:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
pkg watch: batch & de-duplicate file events (#10865) 2023-08-03 14:53:02 -04: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 use go 1.20 -cover support 2023-03-10 16:54:39 +00:00
.golangci.yml ci: bump golangci-lint to v1.53.x (#10659) 2023-06-06 16:31:41 -04:00
BUILDING.md docs: fix grammatical issues (#9997) 2022-11-29 10:52:22 -05:00
CONTRIBUTING.md Broken Link fixed in compose docs 2022-11-30 17:33:58 +01:00
Dockerfile update to go1.20.7 2023-08-02 00:22:13 +02:00
LICENSE Add LICENSE and NOTICE files 2020-08-17 10:20:49 +02:00
MAINTAINERS refresh Maintainers list 2023-01-28 06:37:17 +01:00
Makefile ci: merge Go coverage reports before upload (#10666) 2023-06-08 14:58:21 -04:00
NOTICE move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
README.md Squashed commit of the following: 2022-12-08 21:11:39 +01:00
codecov.yml ci: merge Go coverage reports before upload (#10666) 2023-06-08 14:58:21 -04:00
docker-bake.hcl ci: merge Go coverage reports before upload (#10666) 2023-06-08 14:58:21 -04:00
go.mod build(deps): bump github.com/docker/docker from 24.0.5-0.20230714235725-36e9e796c6fc+incompatible to 24.0.5+incompatible (#10844) 2023-08-01 18:46:15 +00:00
go.sum build(deps): bump github.com/docker/docker from 24.0.5-0.20230714235725-36e9e796c6fc+incompatible to 24.0.5+incompatible (#10844) 2023-08-01 18:46:15 +00:00
logo.png move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00

README.md

Table of Contents

Docker Compose v2

GitHub release PkgGoDev Build Status Go Report Card 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.

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