Define and run multi-container applications with Docker
Go to file
Sebastiaan van Stijn 3678deed14 [v2] use "docker/cli-docs-tool" to generate docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 21:54:26 +02:00
.github release to tag on v2 branch 2021-09-04 09:21:47 +02:00
cmd use a sync.Map to avoid concurrency issue accessing log presenters 2021-09-10 12:54:24 +02:00
docs [v2] use "docker/cli-docs-tool" to generate docs 2021-09-13 21:54:26 +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 set name from project config when recreating container 2021-09-13 10:53:42 +02:00
scripts/validate move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
.dockerignore move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
.gitattributes Removed test requiring linux containers 2020-06-11 12:58:58 +02:00
.gitignore Add Azure sovereign cloud support 2021-02-15 18:38:59 -08:00
.golangci.yml add support for detach keys on compose run|exec 2021-06-29 17:27:43 +02:00
BUILDING.md move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
CONTRIBUTING.md Change URLs to reflect new project home 2021-09-02 09:06:52 +02:00
Dockerfile move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
LICENSE Add LICENSE and NOTICE files 2020-08-17 10:20:49 +02:00
MAINTAINERS move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
Makefile move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
NOTICE move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
README.md Change URLs to reflect new project home 2021-09-02 09:06:52 +02:00
builder.Makefile set internal.Version on github.com/docker/compose/v2 2021-09-02 15:58:46 +02:00
go.mod [v2] use "docker/cli-docs-tool" to generate docs 2021-09-13 21:54:26 +02:00
go.sum [v2] use "docker/cli-docs-tool" to generate docs 2021-09-13 21:54:26 +02:00
logo.png move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00

README.md

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.

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.

Copy the relevant binary for your OS under $HOME/.docker/cli-plugins/docker-compose (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.