Define and run multi-container applications with Docker
Go to file
Aanand Prasad 767a13f771 Merge pull request #2165 from dnephin/more_user_docs
Restructure intro docs
2015-11-03 16:22:28 +00:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Don't set a default network driver, let the server decide. 2015-10-30 11:53:36 -04:00
contrib/completion Add zsh completion for 'docker-compose --x-networking --x-network-driver' 2015-10-19 12:31:17 +02:00
docs Touch up intro paragraph with feedback from @moxiegirl. 2015-11-02 15:16:23 -05: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 On a test failure only show the last 100 lines of daemon output. 2015-11-02 14:16:52 -05:00
tests Move cli tests to a new testing package. 2015-11-02 19:28:58 -05: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 Convert the README to rst and fix the logo url before packaging it up for pypi. 2015-10-28 12:11:29 -04:00
.pre-commit-config.yaml Add upload to bintray from travis. 2015-10-07 14:54:05 -04:00
.travis.yml Add upload to bintray from travis. 2015-10-07 14:54:05 -04:00
CHANGELOG.md Bump 1.4.2 2015-09-23 14:24:13 -04: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 Pipe curl's download directly to extract/execute program to reduce number of commands 2015-10-18 01:06:50 +05:30
Dockerfile.run Update release scripts for release image. 2015-10-06 15:21:34 -04:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Add Mazz to MAINTAINERS 2015-07-01 15:38:07 +01:00
MANIFEST.in Convert the README to rst and fix the logo url before packaging it up for pypi. 2015-10-28 12:11:29 -04:00
README.md Touch up intro paragraph with feedback from @moxiegirl. 2015-11-02 15:16:23 -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 Bundle schema files 2015-09-02 18:09:34 -07: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 Update docker-py to 1.5.0 2015-10-14 11:18:21 -04:00
setup.py Include additional classifiers 2015-10-26 17:08:45 +00:00
tox.ini Enable use of Docker networking with the --x-networking flag 2015-10-14 11:19:43 -04: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.