Define and run multi-container applications with Docker
Go to file
Sebastiaan van Stijn 5d732010a7
replace dockerfile/dockerignore with patternmatcher/ignorefile
The BuildKit dockerignore package was integrated in the patternmatcher
repository / module. This patch updates our uses of the BuildKit package
with its new location.

A small local change was made to keep the format of the existing error message,
because the "ignorefile" package is slightly more agnostic in that respect
and doesn't include ".dockerignore" in the error message.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-23 00:43:17 +02:00
.github update README and CI workflows to match main branch 2023-08-10 15:11:27 +02:00
cmd include: add experimental support for Git resources (#10811) 2023-08-18 09:16:45 -04:00
docs up: handle various attach use cases better 2023-08-18 12:38:38 +02:00
e2e test: temporarily disable an exit-code-from Cucumber test case (#10875) 2023-08-03 14:49:59 -04:00
internal otel: add `include` to project up span 2023-08-22 16:10:18 +02:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
pkg replace dockerfile/dockerignore with patternmatcher/ignorefile 2023-08-23 00:43:17 +02: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 upgrade Golang to 1.21 2023-08-10 15:07:09 +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 update README and CI workflows to match main branch 2023-08-10 15:11:27 +02: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 go.mod: github.com/moby/patternmatcher v0.6.0 2023-08-23 00:40:12 +02:00
go.sum go.mod: github.com/moby/patternmatcher v0.6.0 2023-08-23 00:40:12 +02: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.

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.

Legacy

The Python version of Compose is available under the v1 branch