tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Define and run multi-container applications with Docker
3,228 Commits 24 Branches 262 Tags 66 MiB
Go 97%
Dockerfile 2.1%
Makefile 0.5%
HCL 0.3%
Go to file
Nicolas De Loof 625a48dcf7 `pull` to respect pull_policy 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 		2022-04-12 07:59:58 +02:00
.github update CI github actions comment to mention docs validation 2022-03-18 10:42:05 +01:00
cmd use project we just created to start services 2022-04-07 13:38:30 +02:00
docs Fix search/replace typo in --no-TTY documentation 2022-04-04 19:06:03 +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 `pull` to respect pull_policy 2022-04-12 07:59:58 +02:00
scripts/validate move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
.dockerignore contenairized documetation generation 2022-03-18 10:42:05 +01: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 Update BUILDING.md 2022-03-11 12:47:50 +01:00
CONTRIBUTING.md CONTRIBUTING.md file. Update slack sign-up link 2022-03-04 12:25:11 +01:00
Dockerfile Update golang to 1.17 2021-11-04 09:15:46 +01: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 use a temp directory to generate doc to be sure working tree is clean 2022-03-18 10:42:05 +01:00
NOTICE move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
README.md Update README.md: typographical edit of "About update..." 2021-10-28 13:18:12 +02:00
builder.Makefile contenairized documetation generation 2022-03-18 10:42:05 +01:00
go.mod Merge pull request #9309 from thaJeztah/vendor_containerd_1.6.2 2022-03-31 19:02:47 +02:00
go.sum Merge pull request #9309 from thaJeztah/vendor_containerd_1.6.2 2022-03-31 19:02:47 +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.

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