Define and run multi-container applications with Docker
Go to file
mnowster bc82f065bc Merge pull request #1994 from charleswhchan/patch-3
Touchup "Quickstart Guide: Compose and Django"
2015-10-14 12:46:16 +01:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Improve boolean warning message. 2015-10-07 14:59:08 +01:00
contrib/completion Merge pull request #2032 from villlem/master 2015-09-21 13:41:08 +01:00
docs Touchup "Quickstart Guide: Compose and Django" 2015-10-13 20:10:41 -07:00
experimental Fixes 2015-06-22 08:44:41 -07:00
project Update release scripts for release image. 2015-10-06 15:21:34 -04:00
script Merge pull request #2154 from dnephin/publish_master_builds 2015-10-13 14:50:25 +01:00
tests Improve boolean warning message. 2015-10-07 14:59:08 +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 Configure PyInstaller using docker-compose.spec 2015-09-02 17:47:14 -07:00
.pre-commit-config.yaml Add upload to bintray from travis. 2015-10-07 14:54:05 -04:00
.travis.yml Add upload to bintray from travis. 2015-10-07 14:54:05 -04:00
CHANGELOG.md Bump 1.4.2 2015-09-23 14:24:13 -04:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Running a single test command updated 2015-09-04 17:23:22 +01:00
Dockerfile Trim the dockerfile and re-use the virtualenv we already have. 2015-09-17 18:46:29 -04:00
Dockerfile.run Update release scripts for release image. 2015-10-06 15:21:34 -04:00
LICENSE
MAINTAINERS Add Mazz to MAINTAINERS 2015-07-01 15:38:07 +01:00
MANIFEST.in Fix schema.json MANIFEST.in entry 2015-09-11 19:14:51 -03:00
README.md include logo in README 2015-09-15 09:17:00 +02:00
ROADMAP.md Update roadmap with state convergence 2015-07-21 15:37:55 +01:00
SWARM.md Update Swarm docs 2015-06-15 15:19:55 -07:00
appveyor.yml Add publish to bintray step to appveyor.yml 2015-10-09 10:02:59 -04:00
docker-compose.spec Bundle schema files 2015-09-02 18:09:34 -07:00
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt Split requirements-build.txt from requirements-dev.txt to support a leaner tox.ini 2015-09-01 16:27:44 -04:00
requirements-dev.txt Use py.test as the test runner 2015-09-01 16:27:44 -04:00
requirements.txt Update docker-py to 1.4.0 2015-09-11 15:42:20 -07:00
setup.py Update docker-py to 1.4.0 2015-09-11 15:42:20 -07:00
tox.ini Pass all DOCKER_ env vars to py.test 2015-10-01 12:26:58 +01:00

README.md

Docker Compose

Docker Compose

(Previously known as Fig)

Compose is a tool for defining and running multi-container applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.

Compose is great for development environments, staging servers, and CI. We don't recommend that you use it in production yet.

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

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.