Define and run multi-container applications with Docker
Go to file
Joffrey F 647f260b0a Merge pull request #3774 from aanand/fix-tls-version-error-message
Fix error message for unrecognised TLS version
2016-07-27 10:35:21 -07:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Fix error message for unrecognised TLS version 2016-07-27 18:26:40 +01:00
contrib Merge pull request #3662 from albers/completion-bundle--fetch-digests 2016-07-07 10:39:18 -07:00
docs Merge pull request #3676 from aanand/warn-for-swarm-mode 2016-07-27 15:38:09 +01:00
experimental Remove doc on experimental networking support 2016-07-25 13:38:04 +01:00
project Build osx binary on travis and upload to bintray. 2016-03-01 11:34:54 -05:00
script Upgrade pip on osx 2016-06-30 20:52:15 -04:00
tests Merge pull request #3676 from aanand/warn-for-swarm-mode 2016-07-27 15:38:09 +01:00
.dockerignore alpine docker image for running compose and a script to pull and run it with the 2015-10-02 11:38:35 -04:00
.gitignore Ignore extra coverge files 2015-12-10 15:29:36 -08:00
.pre-commit-config.yaml Tests use updated get_config_paths_from_options signature 2016-03-24 10:57:01 -07:00
.travis.yml Build osx binary on travis and upload to bintray. 2016-03-01 11:34:54 -05:00
CHANGELOG.md Update install.md and CHANGELOG.md for 1.7.1 2016-07-07 11:41:11 -07:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Convert readthedocs links for their .org -> .io migration for hosted projects 2016-06-08 03:52:12 +01:00
Dockerfile Upgade pip to latest 2016-04-26 11:58:41 -04:00
Dockerfile.run Pin base image to alpine:3.4 in Dockerfile.run 2016-07-06 18:01:27 -07:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS update maintainers file for parsing 2015-12-04 16:52:29 +01:00
MANIFEST.in Add the git sha to version output 2015-11-18 13:21:14 -05:00
README.md Readme should use new docker compose format instead of the old one 2016-04-14 10:49:10 +01:00
ROADMAP.md Prevent unnecessary inspection of containers when created from an inspect. 2016-04-06 11:14:42 -04:00
SWARM.md Update Swarm integration guide and make it an official part of the docs 2016-02-19 09:32:43 -08:00
appveyor.yml Move all build scripts to script/build 2016-02-24 16:24:13 -08:00
docker-compose.spec Merge v1 config jsonschemas into a single file. 2016-02-24 15:59:10 -08:00
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt Upgrade pyinstaller. 2016-02-11 13:50:41 -05:00
requirements-dev.txt Use py.test as the test runner 2015-09-01 16:27:44 -04:00
requirements.txt Update docker-py requirement to the latest release 2016-07-26 13:07:38 -07:00
setup.py Update docker-py requirement to the latest release 2016-07-26 13:07:38 -07:00
tox.ini Merge pull request #2388 from dnephin/fix_long_lines 2016-02-25 16:52:33 -08: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:

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.