Define and run multi-container applications with Docker
Go to file
Daniel Nephin 958f96c78a Merge pull request #3269 from dnephin/fix_logs_and_scale_down
Prevent unnecessary inspection of containers
2016-04-06 12:45:46 -04:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Prevent unnecessary inspection of containers when created from an inspect. 2016-04-06 11:14:42 -04:00
contrib Merge pull request #3218 from sdurrheimer/zsh-completion-run-workdir 2016-03-29 16:50:12 +01:00
docs Merge pull request #3187 from bfirsh/update-wordpress-example-to-use-official-images 2016-04-01 20:53:37 +01:00
experimental Update links 2015-12-21 01:52:54 +01:00
project Build osx binary on travis and upload to bintray. 2016-03-01 11:34:54 -05:00
script Build osx binary on travis and upload to bintray. 2016-03-01 11:34:54 -05:00
tests Prevent unnecessary inspection of containers when created from an inspect. 2016-04-06 11:14:42 -04:00
.dockerignore alpine docker image for running compose and a script to pull and run it with the 2015-10-02 11:38:35 -04:00
.gitignore Ignore extra coverge files 2015-12-10 15:29:36 -08:00
.pre-commit-config.yaml Tests use updated get_config_paths_from_options signature 2016-03-24 10:57:01 -07:00
.travis.yml Build osx binary on travis and upload to bintray. 2016-03-01 11:34:54 -05:00
CHANGELOG.md Add release notes for 1.6.2 2016-02-25 17:55:04 -08:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Move test scripts to script/test. 2016-02-24 16:24:13 -08:00
Dockerfile Fix jenkins CI by using an older docker version to match the host. 2015-11-04 15:33:37 -05:00
Dockerfile.run Add the git sha to version output 2015-11-18 13:21:14 -05:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS update maintainers file for parsing 2015-12-04 16:52:29 +01:00
MANIFEST.in Add the git sha to version output 2015-11-18 13:21:14 -05:00
README.md Used absolute links in readme 2016-02-09 13:29:14 +01:00
ROADMAP.md Prevent unnecessary inspection of containers when created from an inspect. 2016-04-06 11:14:42 -04:00
SWARM.md Update Swarm integration guide and make it an official part of the docs 2016-02-19 09:32:43 -08:00
appveyor.yml Move all build scripts to script/build 2016-02-24 16:24:13 -08:00
docker-compose.spec Merge v1 config jsonschemas into a single file. 2016-02-24 15:59:10 -08:00
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt Upgrade pyinstaller. 2016-02-11 13:50:41 -05:00
requirements-dev.txt Use py.test as the test runner 2015-09-01 16:27:44 -04:00
requirements.txt Include docker-py requirements fix 2016-03-31 18:01:51 -07:00
setup.py Require docker-py 1.8.0rc2 2016-03-24 10:13:56 -07:00
tox.ini Merge pull request #2388 from dnephin/fix_long_lines 2016-02-25 16:52:33 -08: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.