Define and run multi-container applications with Docker
Go to file
Joffrey F b68811fd7f Add support for PR cherry picks
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-04-27 19:07:12 +00:00
.circleci Check volume config against remote and error out if diverged 2018-03-12 17:19:03 -07:00
bin
compose "Bump 1.21.1" 2018-04-27 19:03:45 +00:00
contrib Merge pull request from dakotahawkins/dakotahawkins-5790_update-docker-compose.ps1 2018-03-19 05:25:11 -07:00
docs missing "is" 2018-03-23 18:03:08 +01:00
experimental
project
script Add support for PR cherry picks 2018-04-27 19:07:12 +00:00
tests Prevent duplicate binds in generated container config 2018-04-27 18:48:15 +00:00
.dockerignore
.gitignore
.pre-commit-config.yaml
CHANGELOG.md "Bump 1.21.1" 2018-04-27 19:03:45 +00:00
CHANGES.md
CONTRIBUTING.md Keep CONTRIBUTING.md information up to date 2018-02-12 12:06:37 -08:00
Dockerfile
Dockerfile.armhf
Dockerfile.run Add libgcc dependency for Compose in a container 2018-03-23 14:08:06 +01:00
Dockerfile.s390x
Jenkinsfile
LICENSE
MAINTAINERS Fix indentation + HOF comment 2018-03-15 12:20:00 -07:00
MANIFEST.in
README.md
SWARM.md
appveyor.yml
docker-compose.spec Add 2.4 file format with platform support. Also reads DOCKER_DEFAULT_PLATFORM env 2018-03-30 12:39:10 -07:00
logo.png
requirements-build.txt
requirements-dev.txt
requirements.txt Bump SDK version to latest 2018-04-27 18:48:13 +00:00
setup.cfg
setup.py Bump SDK version to latest 2018-04-27 18:48:13 +00:00
tox.ini

README.md

Docker Compose

Docker Compose

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a Compose file to configure your application's services. Then, using a single command, you create and start all the services from your configuration. To learn more about all the features of Compose see the list of features.

Compose is great for development, testing, and staging environments, as well as CI workflows. You can learn more about each case in Common Use Cases.

Using Compose is basically 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 docker-compose.yml 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 docker-compose.yml looks like this:

version: '2'

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

For more information about the Compose file, see the Compose file reference

Compose has commands for managing the whole lifecycle of your application:

  • Start, stop and rebuild services
  • View the status of running services
  • Stream the log output of running services
  • Run a one-off command on a service

Installation and documentation

Contributing

Build Status

Want to help build Compose? Check out our contributing documentation.

Releasing

Releases are built by maintainers, following an outline of the release process.