Define and run multi-container applications with Docker
Go to file
Daniel Nephin 9d7ad796a3 bump requests to 2.7 to fix the ResponseNotReady() error, and add a missing default for tox posargs
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-09-03 14:11:44 -04:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Merge pull request #1965 from dnephin/fix_compose_up_attach 2015-09-02 17:37:43 -07:00
contrib/completion Merge pull request #1928 from albers/completion-timeout 2015-08-27 12:37:55 -04:00
docs Merge pull request #1940 from hermanjunge/patch-1 2015-08-31 10:43:30 +01:00
experimental Fixes 2015-06-22 08:44:41 -07:00
project Add ISSUE-TRIAGE.md doc 2015-08-28 14:10:15 -04:00
script Configure PyInstaller using docker-compose.spec 2015-09-02 17:47:14 -07:00
tests Merge pull request #1965 from dnephin/fix_compose_up_attach 2015-09-02 17:37:43 -07:00
.dockerignore Configure PyInstaller using docker-compose.spec 2015-09-02 17:47:14 -07:00
.gitignore Configure PyInstaller using docker-compose.spec 2015-09-02 17:47:14 -07:00
.pre-commit-config.yaml Add pre-commit hooks 2015-08-24 17:04:45 -04:00
CHANGELOG.md Run pre-commit on all files 2015-08-24 17:04:50 -04:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Merge pull request #1918 from dnephin/fix_scripts_test 2015-09-02 14:28:51 -07:00
Dockerfile Split requirements-build.txt from requirements-dev.txt to support a leaner tox.ini 2015-09-01 16:27:44 -04:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Add Mazz to MAINTAINERS 2015-07-01 15:38:07 +01:00
MANIFEST.in Cleanup requirements.txt so we don't have to maintain separate copies for py2 and py3. 2015-08-25 10:46:08 -04:00
README.md Run pre-commit on all files 2015-08-24 17:04:50 -04: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
docker-compose.spec Bundle schema files 2015-09-02 18:09:34 -07: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 bump requests to 2.7 to fix the ResponseNotReady() error, and add a missing default for tox posargs 2015-09-03 14:11:44 -04:00
setup.py bump requests to 2.7 to fix the ResponseNotReady() error, and add a missing default for tox posargs 2015-09-03 14:11:44 -04:00
tox.ini bump requests to 2.7 to fix the ResponseNotReady() error, and add a missing default for tox posargs 2015-09-03 14:11:44 -04:00

README.md

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.