Define and run multi-container applications with Docker
Go to file
Milas Bowman 13115468d5
cli: fix `--build` flag for `create` (#10982)
I missed this during a refactor and there wasn't test coverage.
Instead of adding more heavy-weight integration tests, I tried
to use `gomock` here to assert on the options objects after CLI
flag parsing. I think with a few more helpers, this could be a
good way to get a lot more combinations covered without adding
a ton of slow E2E tests.

Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2023-09-08 11:35:57 -04:00
.github update README and CI workflows to match main branch 2023-08-10 15:11:27 +02:00
cmd cli: fix `--build` flag for `create` (#10982) 2023-09-08 11:35:57 -04:00
docs watch: build & launch the project at start (#10957) 2023-09-07 13:27:23 -04:00
e2e test: temporarily disable an exit-code-from Cucumber test case (#10875) 2023-08-03 14:49:59 -04:00
internal watch: only allow a single instance per-project 2023-08-25 15:49:28 +02:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
pkg watch: build & launch the project at start (#10957) 2023-09-07 13:27:23 -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 ci: bump golangci-lint to v1.54.2 2023-08-24 08:57:47 +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 doc: updated README.md to remove broken link 2023-09-04 20:57:41 +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 cli: fix `--build` flag for `create` (#10982) 2023-09-08 11:35:57 -04:00
go.sum pull OCI remote resource 2023-09-07 07:27:32 +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.