Define and run multi-container applications with Docker
Go to file
Aanand Prasad 4035a203fa Merge pull request #1745 from bfirsh/2015-07-21-roadmap-update
Update roadmap with state convergence
2015-07-21 16:01:13 +01: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 #1711 from aanand/custom-names 2015-07-21 14:28:16 +01:00
contrib/completion Update bash and zsh completion for --force-recrate 2015-07-20 17:18:39 +01:00
docs Merge pull request #1711 from aanand/custom-names 2015-07-21 14:28:16 +01:00
experimental Fixes 2015-06-22 08:44:41 -07:00
script Merge pull request #1539 from bfirsh/add-image-affinity-to-test 2015-06-12 11:56:02 -04:00
tests Merge pull request #1711 from aanand/custom-names 2015-07-21 14:28:16 +01:00
.dockerignore Add build and dist to dockerignore 2015-05-29 13:07:19 +01: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.4.0dev 2015-06-18 11:56:43 -07:00
CONTRIBUTING.md Link to waffle board from CONTRIBUTING.md 2015-07-15 11:56:46 +01:00
Dockerfile Test against Docker 1.6.2 and 1.7.1 2015-07-15 14:37:44 +01: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 add bash completion to sdist 2015-02-28 15:18:29 -06:00
README.md Split out release process 2015-07-01 15:58:11 +01:00
RELEASE_PROCESS.md Don't use future tense 2015-07-01 18:06:09 +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
requirements-dev.txt Update pep8, fix errors and freeze requirements-dev.txt 2015-02-11 19:00:13 +00:00
requirements.txt Make parallel tasks interruptible with Ctrl-C 2015-07-20 14:13:25 +01:00
setup.py Fix required version of websockets-client 2015-07-21 11:59:32 +02: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

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

Releasing

Releases are built by maintainers, following an outline of the release process.