Define and run multi-container applications with Docker
Go to file
Joffrey F 1b275b4f22 Merge pull request #4669 from ucalgary/4517-preserve-deploy-options
Merge deploy options in service dicts
2017-03-24 15:02:46 -07:00
bin
compose Merge deploy key in service dicts 2017-03-24 15:03:53 -06:00
contrib Merge pull request #4641 from albers/completion-pull--parallel 2017-03-20 11:36:29 -07:00
docs updated README per vnext branch plan 2016-10-05 16:19:09 -07:00
experimental
project Update release process document to account for recent changes. 2016-10-20 17:47:07 -07:00
script Improve Dockerfile.run 2017-03-03 15:17:10 -08:00
tests Merge deploy key in service dicts 2017-03-24 15:03:53 -06:00
.dockerignore
.gitignore Handle giving help a nonexistent command 2016-12-03 14:58:15 -05:00
.pre-commit-config.yaml
.travis.yml
CHANGELOG.md Merge pull request #4438 from fate-grand-order/master 2017-02-09 16:35:35 -08:00
CHANGES.md
CONTRIBUTING.md
Dockerfile Upgrade python and pip versions in Dockerfile 2017-02-01 14:12:41 -08:00
Dockerfile.armhf Add support to build docker-compose on ARM 32bit 2017-02-08 12:52:10 +00:00
Dockerfile.run Improve Dockerfile.run 2017-03-03 15:17:10 -08:00
Jenkinsfile Limit testing pool to Ubuntu hosts to avoid errors with dind not 2016-11-14 17:23:25 -08:00
LICENSE
MAINTAINERS
MANIFEST.in
README.md Update README.md 2017-02-21 14:56:07 -08:00
ROADMAP.md
SWARM.md
appveyor.yml
docker-compose.spec Fix version 3.1 2017-02-09 12:39:57 -05:00
logo.png
requirements-build.txt Use newer version of PyInstaller to fix prelinking issues 2017-01-30 13:52:27 -08:00
requirements-dev.txt
requirements.txt Update docker SDK dependency 2017-02-16 17:05:09 -08:00
setup.cfg enable universal wheels 2017-01-04 18:33:58 +00:00
setup.py Update docker SDK dependency 2017-02-16 17:05:09 -08:00
tox.ini

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:

version: '2'

services:
  web:
    build: .
    ports:
     - "5000:5000"
    volumes:
     - .:/code
  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.