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,771 Commits 19 Branches 259 Tags 62 MiB
Go 96.9%
Dockerfile 2.2%
Makefile 0.5%
HCL 0.3%
Go to file
Sebastiaan van Stijn 5ec37d08a5 build: replace uses of archive.CanonicalTarNameForPath 
This function is an alias for filepath.IsAbs and we are considering deprecating
and/or removing this function in the archive package, so removing its uses
helps transitioning if we decide to deprecate and/or remove it.

[docker/cli@fb0788f] also added a normalize step in TrimBuildFilesFromExcludes,
so that callers are not _required_ to first normalize the path, so the
normalizeation may be redunant, but keeping the normalization as this variable
is used further down the code.

[docker/cli@fb0788f]: fb0788f18f

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 		2024-06-17 12:00:24 +02:00
.github update gh actions versions, update engine matrix, bump golang to 1.21.11 2024-06-12 18:16:29 +02:00
cmd config --environment 2024-06-11 06:59:19 +02:00
docs config --environment 2024-06-11 06:59:19 +02:00
internal drop COMPOSE_EXPERIMENTAL_OTEL as docker/cli has opentelemetry in 2024-05-24 10:27:23 +02:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
pkg build: replace uses of archive.CanonicalTarNameForPath 2024-06-17 12:00:24 +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 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 Remove dead url reference. 2024-04-09 17:50:24 +02:00
Dockerfile update gh actions versions, update engine matrix, bump golang to 1.21.11 2024-06-12 18:16:29 +02:00
LICENSE Add LICENSE and NOTICE files 2020-08-17 10:20:49 +02:00
MAINTAINERS update MAINTAINERS file 2024-01-25 14:28:44 +00:00
Makefile Bump docker engine and cli to version 26.1.3 2024-05-17 13:18:14 +02:00
NOTICE move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
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 Fix dot env file to define COMPOSE_* variables 2024-06-08 14:55:36 +02:00
go.sum Fix dot env file to define COMPOSE_* variables 2024-06-08 14:55:36 +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 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.