Define and run multi-container applications with Docker
Перейти к файлу
Guillaume Lours a8bfbc147a bump compose-go v2.4.4
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2024-11-07 14:19:53 +01:00
.github
cmd introduce generate command as alpha command 2024-10-28 17:00:59 +01:00
docs introduce generate command as alpha command 2024-10-28 17:00:59 +01:00
internal remove ArtifactType from Config in OCI v1.1 definition of the artifact 2024-11-05 15:10:56 +01:00
packaging
pkg Avoid starting all services on rebuild 2024-11-05 14:51:12 +00:00
.dockerignore
.gitattributes
.gitignore
.golangci.yml
BUILDING.md
CONTRIBUTING.md
Dockerfile bump golang minimal version to 1.22 in go.mod 2024-10-29 11:45:02 +01:00
LICENSE
MAINTAINERS Update `MAINTAINERS` file 2024-10-30 13:33:46 +01:00
Makefile
NOTICE
README.md
codecov.yml
docker-bake.hcl
go.mod bump compose-go v2.4.4 2024-11-07 14:19:53 +01:00
go.sum bump compose-go v2.4.4 2024-11-07 14:19:53 +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.