Define and run multi-container applications with Docker
Go to file
Aanand Prasad 683c8b0067 Merge pull request from sdurrheimer/zsh-completion-down-command
Add zsh completion for 'docker-compose down'
2016-01-19 10:40:29 +00:00
bin
compose Allow custom ipam config 2016-01-18 18:56:18 +00:00
contrib/completion Merge pull request from sdurrheimer/zsh-completion-down-command 2016-01-19 10:40:29 +00:00
docs Update networking docs 2016-01-18 18:45:29 +00:00
experimental Update links 2015-12-21 01:52:54 +01:00
project
script Fix some bugs in release scripts. 2016-01-18 15:59:40 -05:00
tests Allow custom ipam config 2016-01-18 18:56:18 +00:00
.dockerignore
.gitignore
.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
CHANGELOG.md Update links 2015-12-21 01:52:54 +01:00
CHANGES.md
CONTRIBUTING.md Update links 2015-12-21 01:52:54 +01:00
Dockerfile
Dockerfile.run
LICENSE
MAINTAINERS
MANIFEST.in
README.md Update links 2015-12-21 01:52:54 +01:00
ROADMAP.md
SWARM.md
appveyor.yml
docker-compose.spec Move logging config changes to v2 spec 2016-01-08 13:21:45 -08:00
logo.png
requirements-build.txt
requirements-dev.txt
requirements.txt Refactor config loading to move version check into ConfigFile. 2016-01-14 11:45:15 -05:00
setup.py Require volumes_from a container to be explicit in V2 config. 2016-01-14 11:45:16 -05:00
tox.ini Test against a dev build of Engine 1.10 2016-01-15 02:46:20 +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.