Define and run multi-container applications with Docker
Go to file
Daniel Nephin 9faa852d41 Merge pull request #3921 from shin-/3890-pull-services
Fix command hint in bundle to pull services instead of images
2016-09-13 10:32:14 -04:00
bin
compose Merge pull request #3921 from shin-/3890-pull-services 2016-09-13 10:32:14 -04:00
contrib Shell completion for --push-images 2016-07-27 16:00:53 +01:00
docs Merge pull request #3814 from aanand/disambiguate-swarm 2016-09-07 10:46:14 +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 Bump 1.8.0 2016-07-27 13:30:06 -07:00
tests Merge pull request #3830 from shin-/3534-machine-config-args 2016-09-07 18:35:43 -07:00
.dockerignore
.gitignore
.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 Bump 1.8.0-rc3 2016-07-27 13:22:20 -07:00
CHANGES.md
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
Jenkinsfile Add docs checking Jenkinsfile 2016-08-22 12:18:07 +10:00
LICENSE
MAINTAINERS
MANIFEST.in
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
appveyor.yml
docker-compose.spec
logo.png
requirements-build.txt
requirements-dev.txt
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.