Define and run multi-container applications with Docker
Go to file
Joffrey F fc7b74d7f9 Bump to next dev version
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-02-08 13:47:08 -08:00
bin
compose Bump to next dev version 2017-02-08 13:47:08 -08:00
contrib Added `top` to `docker-compose` to display running processes. 2017-02-01 15:42:30 -08:00
docs updated README per vnext branch plan 2016-10-05 16:19:09 -07:00
experimental Remove doc on experimental networking support 2016-07-25 13:38:04 +01:00
project Update release process document to account for recent changes. 2016-10-20 17:47:07 -07:00
script Bump to next dev version 2017-02-08 13:47:08 -08:00
tests Merge pull request #4419 from shin-/4418-healthcheck-extends 2017-02-03 12:24:53 -08:00
.dockerignore
.gitignore
.pre-commit-config.yaml
.travis.yml
CHANGELOG.md Bump 1.10.1 2017-02-08 13:45:25 -08:00
CHANGES.md
CONTRIBUTING.md
Dockerfile Upgrade python and pip versions in Dockerfile 2017-02-01 14:12:41 -08:00
Dockerfile.run Fix docker image build script when using universal wheels 2017-01-10 16:43:26 -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 fix(docs): updated documentation links 2016-10-24 15:41:31 +01:00
ROADMAP.md
SWARM.md
appveyor.yml
docker-compose.spec Add 3.0 schema to docker-compose.spec 2017-01-04 11:26:45 -08: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 Bump docker SDK version 2017-01-30 16:49:05 -08:00
setup.cfg enable universal wheels 2017-01-04 18:33:58 +00:00
setup.py Bump docker SDK version 2017-01-30 16:49:05 -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.