compose

Docker Compose v2

Docker Compose is an effective tool designed for running multi-container applications with ease on Docker. It leverages the Compose file format to streamline the configuration and management of applications composed of one or more containers. Essentially, a Compose file is utilized to specify the configuration of each container within an application, allowing developers to streamline the launch of their entire application by executing a single docker compose up command.

Where to Get Docker Compose

Windows and macOS

For users operating on Windows and macOS, Docker Compose is conveniently bundled within Docker Desktop, making the installation process straightforward and integrated with the Docker ecosystem.

Linux

For Linux users, Docker Compose binaries can be sourced from the release page in the Compose repository. To install, rename the binary according to your OS specifications to docker-compose, and position it in the $HOME/.docker/cli-plugins directory. Alternatively, for a system-wide installation, the binary can be placed in:

• /usr/local/lib/docker/cli-plugins or /usr/local/libexec/docker/cli-plugins
• /usr/lib/docker/cli-plugins or /usr/libexec/docker/cli-plugins

Ensure the binary is executable by applying chmod +x if necessary.

Quick Start

To utilize Docker Compose, follow this streamlined three-step procedure:

1. Environment Definition: Begin by defining your application's environment in a Dockerfile, allowing for precise replication anywhere.

2. Service Configuration: Define the services that constitute your application in a compose.yaml file so they can operate collectively within an isolated environment.

3. Application Execution: Finally, execute docker compose up to initiate and run your complete application.

An example of a simple Compose file:

services:
  web:
    build: .
    ports:
      - "5000:5000"
    volumes:
      - .:/code
  redis:
    image: redis

Contributing

Those interested in contributing to the development of Docker Compose can engage with the project by referencing the contributing documentation. For issues or bugs, stakeholders are encouraged to report them via the issue tracker.

Legacy

For those interested in the history or legacy systems, the Python version of Docker Compose can be found under the v1 branch in the repository, maintaining support for users who rely on the earlier iteration.