Define and run multi-container applications with Docker
Go to file
Mazz Mosley 6e6dbdad95 working_dir is no longer optional
When building test data using make_service_dict, we need to include
working_dir as it is core to some of the functionality of
ServiceLoader.

Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com>
2015-07-03 14:56:18 +01:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose working_dir is no longer optional 2015-07-03 14:56:18 +01:00
contrib/completion Add --help to subcommands in zsh completion 2015-06-26 09:00:47 +02:00
docs Support reading config from stdin. 2015-07-02 22:16:22 -04: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 working_dir is no longer optional 2015-07-03 14:56:18 +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 Zsh completion for docker-compose 2015-05-29 14:24:55 +02:00
Dockerfile Use Docker 1.7.0 2015-06-18 10:34:34 -07: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 Update dockerproject.com links 2015-06-03 23:03:17 +02: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 Update docker-py to 1.2.3 final 2015-06-18 11:11:51 -07:00
setup.py Update docker-py to 1.2.3 final 2015-06-18 11:11:51 -07: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.