Define and run multi-container applications with Docker
Go to file
Daniel Nephin 517d3a581c Merge pull request #2768 from aanand/fix-make-branch
Fixes to make-branch script
2016-01-28 15:05:21 -05:00
bin
compose Merge pull request #2706 from dnephin/dont_copy_host_volumes 2016-01-28 15:02:53 -05:00
contrib Extract helper methods 2016-01-26 16:08:34 +00:00
docs New navigation for 1.10 release 2016-01-27 12:05:56 -08:00
experimental Update links 2015-12-21 01:52:54 +01:00
project
script Let the user specify any repo as their fork 2016-01-27 15:40:28 +00:00
tests Merge pull request #2706 from dnephin/dont_copy_host_volumes 2016-01-28 15:02:53 -05:00
.dockerignore
.gitignore
.pre-commit-config.yaml Update pre-commit config to enforace that future imports exist in all files. 2016-01-07 13:09:03 -05:00
.travis.yml
CHANGELOG.md Update links 2015-12-21 01:52:54 +01:00
CHANGES.md
CONTRIBUTING.md Update links 2015-12-21 01:52:54 +01:00
Dockerfile
Dockerfile.run
LICENSE
MAINTAINERS
MANIFEST.in
README.md Update links 2015-12-21 01:52:54 +01:00
ROADMAP.md
SWARM.md
appveyor.yml
docker-compose.spec Move logging config changes to v2 spec 2016-01-08 13:21:45 -08:00
logo.png
requirements-build.txt
requirements-dev.txt
requirements.txt Bump docker-py version to latest RC 2016-01-27 00:36:38 +00:00
setup.py Require volumes_from a container to be explicit in V2 config. 2016-01-14 11:45:16 -05:00
tox.ini Test against a dev build of Engine 1.10 2016-01-15 02:46:20 +00:00

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:

web:
  build: .
  ports:
   - "5000:5000"
  volumes:
   - .:/code
  links:
   - redis
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.