Define and run multi-container applications with Docker
Go to file
Daniel Nephin 5b32d32b2d Merge pull request #2521 from jeanpralo/master
Add method to get more info about container status
2015-12-15 12:04:42 -08:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose add restarting status for human_readable_state 2015-12-16 08:19:28 +13:00
contrib/completion Merge pull request #2522 from sdurrheimer/zsh-completion-config-cmd 2015-12-09 10:40:44 -08:00
docs Merge pull request #2512 from albers/completion-url 2015-12-08 16:27:09 +00:00
experimental Fixes 2015-06-22 08:44:41 -07:00
project Merge pull request #2276 from dnephin/update_networking_docs 2015-10-29 15:19:02 +00:00
script Merge pull request #2513 from punkstar/detect-tty 2015-12-08 15:26:46 +00:00
tests Fix dns and dns_search when used strings and without extends. 2015-12-09 16:32:39 -08: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 Add the git sha to version output 2015-11-18 13:21:14 -05:00
.pre-commit-config.yaml Add upload to bintray from travis. 2015-10-07 14:54:05 -04:00
.travis.yml Fixing matrix include so `os: linux` goes to trusty 2015-11-20 16:07:37 -08:00
CHANGELOG.md Cherry-pick release notes for 1.5.2 2015-12-04 10:26:20 -08:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Running a single test command updated 2015-09-04 17:23:22 +01: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 Fix use case link in readme. 2015-11-19 14:53:28 -05:00
ROADMAP.md Update roadmap with state convergence 2015-07-21 15:37:55 +01:00
SWARM.md Update Swarm docs 2015-06-15 15:19:55 -07:00
appveyor.yml Add publish to bintray step to appveyor.yml 2015-10-09 10:02:59 -04:00
docker-compose.spec Add the git sha to version output 2015-11-18 13:21:14 -05:00
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt Upgrade pyinstaller to 3.0 2015-10-23 13:34:49 -04:00
requirements-dev.txt Use py.test as the test runner 2015-09-01 16:27:44 -04:00
requirements.txt Fix texttable dep. 0.8.2 was removed from pypi. 2015-11-17 18:36:58 -05:00
setup.py Include additional classifiers 2015-10-26 17:08:45 +00:00
tox.ini Refactor parallel_execute. 2015-11-20 17:09:51 -05: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.