Define and run multi-container applications with Docker
Go to file
Joffrey F ec3af7d491 Merge pull request #2920 from londoncalling/docs-examples
update to description of files generated from examples, which are no …
2016-02-16 11:51:14 -08:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Merge pull request #2893 from shin-/2833-run-dependencies 2016-02-12 16:33:01 -05:00
contrib Merge pull request #2740 from albers/completion-create 2016-02-01 15:44:07 +00:00
docs update to description of files generated from examples, which are no longer owned by root w/new release 2016-02-16 11:34:59 -08:00
experimental Update links 2015-12-21 01:52:54 +01:00
project Merge pull request #2276 from dnephin/update_networking_docs 2015-10-29 15:19:02 +00:00
script Run test containers in TTY mode 2016-02-02 13:31:28 +00:00
tests Merge pull request #2893 from shin-/2833-run-dependencies 2016-02-12 16:33:01 -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 Ignore extra coverge files 2015-12-10 15:29:36 -08:00
.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 Fixing matrix include so `os: linux` goes to trusty 2015-11-20 16:07:37 -08:00
CHANGELOG.md Fix upgrading url. 2016-02-08 18:15:21 -05:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Update links 2015-12-21 01:52:54 +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 Used absolute links in readme 2016-02-09 13:29:14 +01: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 Deploying to bintray from appveyor using the new bintray support. 2016-02-01 16:44:45 -05:00
docker-compose.spec Make 'version' a string 2016-02-02 13:58:34 +00: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 Add support for shm_size. Fixes #2823. 2016-02-10 15:25:18 -06:00
setup.py Update docker-py and dockerpty 2016-02-04 19:16:01 +00:00
tox.ini Add pytest section to tox.ini 2016-02-05 13:07:01 +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.