Define and run multi-container applications with Docker
Go to file
Aanand Prasad 58a7844129 Merge pull request #1482 from bfirsh/add-build-and-dist-to-dockerignore
Make it possible to run tests remotely
(cherry picked from commit c8e096e089)

Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
2015-06-15 11:22:07 -07: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 #1537 from aanand/reorder-service-utils 2015-06-15 11:22:07 -07:00
contrib/completion Merge pull request #1481 from albers/completion-smart-recreate 2015-06-09 14:39:52 -04:00
docs Merge pull request #1475 from fordhurley/patch-1 2015-06-15 11:22:07 -07:00
script Merge pull request #1482 from bfirsh/add-build-and-dist-to-dockerignore 2015-06-15 11:22:07 -07:00
tests Merge pull request #1480 from bfirsh/change-sigint-test-to-use-sigstop 2015-06-15 11:22:07 -07:00
.dockerignore Merge pull request #1482 from bfirsh/add-build-and-dist-to-dockerignore 2015-06-15 11:22:07 -07:00
.gitignore Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
CHANGES.md Bump 1.2.0 2015-04-16 17:48:28 +01:00
CONTRIBUTING.md Merge pull request #1325 from sdurrheimer/master 2015-06-09 14:39:50 -04:00
Dockerfile Merge pull request #1497 from aanand/use-1.7-rc1 2015-06-15 11:22:06 -07:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Remove @d11wtq as a maintainer 2015-02-27 11:18:41 +00:00
MANIFEST.in add bash completion to sdist 2015-02-28 15:18:29 -06:00
README.md Update description of Compose 2015-05-26 15:42:55 +01:00
ROADMAP.md Document Swarm integration 2015-02-25 10:45:40 +00:00
SWARM.md Update Swarm doc 2015-03-30 11:34:26 -04:00
requirements-dev.txt Update pep8, fix errors and freeze requirements-dev.txt 2015-02-11 19:00:13 +00:00
requirements.txt Merge pull request #1529 from aanand/update-dockerpty 2015-06-09 18:24:14 -04:00
setup.py Merge pull request #1529 from aanand/update-dockerpty 2015-06-09 18:24:14 -04:00
tox.ini make flake8 a bit more specific 2015-03-26 09:09:15 -07:00

README.md

Docker Compose

(Previously known as Fig)

Compose is a tool for defining and running multi-container applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.

Compose is great for development environments, staging servers, and CI. We don't recommend that you use it in production yet.

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

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](http://jenkins.dockerproject.com/buildStatus/icon?job=Compose Master)

Want to help build Compose? Check out our contributing documentation.