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
4,636 Commits 25 Branches 264 Tags 66 MiB
Go 97%
Dockerfile 2.1%
Makefile 0.5%
HCL 0.3%
Go to file
Milas Bowman acf2ffb0c7 feat(tracing): add project hash attr 
Hash the project config and add it as an attribute. This can be
used to group multiple spans.

Signed-off-by: Milas Bowman <milas.bowman@docker.com>
 		2024-02-08 15:47:25 +01:00
.github CI: docker engine version matrix 2024-02-05 12:09:45 +01:00
cmd chore(load): ensure context passed to load 2024-02-08 15:46:37 +01:00
docs docs: update link to use canonical URL for command 2024-01-19 11:38:14 +01:00
internal feat(tracing): add project hash attr 2024-02-08 15:47:25 +01:00
packaging
…
pkg Include all networks in ContainerCreate call if API >= 1.44 2024-02-07 16:21:15 +01:00
.dockerignore
…
.gitattributes
…
.gitignore use go 1.20 -cover support 2023-03-10 16:54:39 +00:00
.golangci.yml deps: remove deprecated github.com/pkg/errors 2023-09-29 06:28:58 +02:00
BUILDING.md docs: fix grammatical issues (#9997) 2022-11-29 10:52:22 -05:00
CONTRIBUTING.md let contributor know we might close unanswered issues 2023-11-23 11:06:31 +01:00
Dockerfile ci(deps): bump golangci-lint to v1.55.2 2024-01-10 12:56:48 -05:00
LICENSE
…
MAINTAINERS update MAINTAINERS file 2024-01-25 14:28:44 +00:00
Makefile github.com/golang/mock is deprecated 2023-12-13 14:47:39 +01:00
NOTICE
…
README.md Update README.md to use standard compose.yaml file name 2023-11-30 08:53:44 +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 bump compose-go to v2.0.0-rc.4 2024-02-07 10:44:44 +01:00
go.sum bump compose-go to v2.0.0-rc.4 2024-02-07 10:44:44 +01:00
logo.png
…

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