compose README

The project's README from github.com/docker/compose. As one markdown file: README.md.

Table of Contents

Docker Compose

GitHub release PkgGoDev Build Status 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.

Note: About Docker Swarm Docker Swarm used to rely on the legacy compose file format but did not adopt the compose specification so is missing some of the recent enhancements in the compose syntax. After acquisition by Mirantis swarm isn't maintained by Docker Inc, and as such some Docker Compose features aren't accessible to swarm users.

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:

(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.

compose (docker/compose)

Searching Database…

38.4K ·GitHub
Compose
Что это такое?Docker Compose — это инструмент для описания и запуска приложений из нескольких контейнеров Docker, которые настраиваются через один файл Compose (compose.yaml).
Это отдельный инструмент или часть Docker?Это CLI-плагин для Docker, который вызывается командой 'docker compose' и поставляется в составе Docker Desktop для Windows и macOS.
Как запустить Docker Compose?На Windows и macOS он поставляется вместе с Docker Desktop. В Linux скачайте бинарный файл со страницы релизов, переименуйте его в docker-compose и поместите в папку cli-plugins, например $HOME/.docker/cli-plugins или /usr/local/lib/docker/cli-plugins.
Нужно ли что-то помимо самого Docker?Нужен установленный движок Docker, так как Compose — это плагин, который работает поверх него. В Linux может потребоваться вручную выдать бинарному файлу право на выполнение через chmod.
Docker Swarm получает те же возможности?Нет. Docker Swarm по-прежнему использует устаревший формат файлов compose и не поддерживает новые улучшения спецификации compose, поэтому некоторые новые возможности Compose недоступны пользователям Swarm.
На каких платформах это работает?На Windows и macOS — через Docker Desktop, а на Linux — через отдельный бинарный файл, установленный как CLI-плагин.
Как выглядит базовый процесс работы?Вы описываете Dockerfile для окружения вашего приложения, задаёте сервисы в compose.yaml, а затем запускаете docker compose up, чтобы поднять весь стек.
Есть ли более старая версия на Python?Да, оригинальная реализация на Python (Compose v1) по-прежнему доступна в ветке v1, но версия этого репозитория на Go — текущая.
Чем это отличается от обычного docker run?Вместо того чтобы вручную запускать и связывать контейнеры по одному, вы описываете все сервисы, сети и тома в одном YAML-файле и поднимаете их одной командой.
What are similar projects?k9s, kompose, rook, dokku, minikube, kops, ctop, tilt
Which topics is it in?infrastructure, deployment, containers, orchestration, golang, kubernetes, docker-compose, command-line, devops, go, terminal, apache-2.0
Creator
docker
Size
29.3 MB
Stars
38.4K
Updated
CommitOct 16Releasev5.6.0Oct 02
Age
12y
Commits · 90 Days