Remzona54/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2026-08-30 13:31:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
Define and run multi-container applications with Docker https://docs.docker.com/compose/
5999 commits 40 branches 305 tags 72 MiB
Find a file
Nicolas De Loof a472f714d5 registry: encode credentials with moby's authconfig package 
EncodedAuth now delegates the X-Registry-Auth wire encoding to
moby/api/pkg/authconfig (same module, already required) instead of
hand-rolling the JSON+base64url pair, and push.go reuses it instead of
its own copy. The CLI and moby AuthConfig structs are field-for-field
identical, so a direct type conversion bridges them.

The explicit GetAuthConfigKey normalization drops out of EncodedAuth:
docker/cli's configfile.GetAuthConfig normalizes the Docker Hub domain
itself. It remains for the OCI resolver, whose credential callback
receives the network host actually contacted (registry-1.docker.io),
which the configfile does not map.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-08-25 17:27:26 +02:00
.github ci: validate the generated mocks are in sync 2026-08-20 15:16:43 +02:00
cmd fix(display): stop ttyWriter.Done from hanging after context cancel 2026-08-25 11:38:50 +02:00
desktop-module build and push Docker Desktop module image on release 2026-04-10 16:12:09 +02:00
docs docs(hooks): document pre_start hook container retention and cleanup 2026-08-20 18:57:02 +02:00
internal registry: encode credentials with moby's authconfig package 2026-08-25 17:27:26 +02:00
pkg registry: encode credentials with moby's authconfig package 2026-08-25 17:27:26 +02:00
.dockerignore
.gitattributes
.gitignore distinguish event (short) status text and details 2025-11-04 10:18:55 +01:00
.go-version bump golang to version 1.26.6 2026-08-14 14:20:41 +02:00
.golangci.yml lint: explicitly disable gocyclo so it doesn't sneak back in 2026-08-18 10:42:37 +02:00
AGENTS.md test(e2e): checks.go as the reviewed vocabulary, SCENARIO.md codifies the contract 2026-08-18 16:49:56 +02:00
BUILDING.md Add go as a prerequesite in build instructions 2025-08-06 15:27:09 +02:00
CLAUDE.md docs: adopt AGENTS.md standard, symlink CLAUDE.md to it 2026-07-21 17:43:06 +02:00
codecov.yml ci: merge Go coverage reports before upload (#10666) 2023-06-08 14:58:21 -04:00
CONTRIBUTING.md docs: update CONTRIBUTING.md to reflect current tooling and practices 2026-08-20 12:04:50 +02:00
docker-bake.hcl ci: validate the generated mocks are in sync 2026-08-20 15:16:43 +02:00
Dockerfile ci: validate the generated mocks are in sync 2026-08-20 15:16:43 +02:00
go.mod remove buildx as a Go dependency 2026-08-25 17:27:26 +02:00
go.sum remove buildx as a Go dependency 2026-08-25 17:27:26 +02:00
LICENSE
logo.png
Makefile chore(mocks): fix the stale mockgen invocation and pin its version 2026-08-20 15:16:43 +02:00
NOTICE
README.md README: remove Go Report Card badge 2026-07-16 11:39:14 +02:00

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

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:

  • /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.