Define and run multi-container applications with Docker
Go to file
Aanand Prasad c63ae64ca6 Merge pull request #1920 from dnephin/use_pytest
Use py.test as a test runner
2015-09-01 15:29:24 -07:00
bin
compose Merge pull request #1933 from dnephin/fix_scale_test_flakes 2015-08-31 13:52:33 -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
project Add ISSUE-TRIAGE.md doc 2015-08-28 14:10:15 -04:00
script Split requirements-build.txt from requirements-dev.txt to support a leaner tox.ini 2015-09-01 16:27:44 -04:00
tests Merge pull request #1933 from dnephin/fix_scale_test_flakes 2015-08-31 13:52:33 -07:00
.dockerignore Normalise ignore files 2015-08-27 13:51:51 +01:00
.gitignore Normalise ignore files 2015-08-27 13:51:51 +01:00
.pre-commit-config.yaml
CHANGELOG.md
CHANGES.md
CONTRIBUTING.md
Dockerfile Split requirements-build.txt from requirements-dev.txt to support a leaner tox.ini 2015-09-01 16:27:44 -04:00
LICENSE
MAINTAINERS
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
ROADMAP.md
SWARM.md
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
setup.py Use py.test as the test runner 2015-09-01 16:27:44 -04:00
tox.ini Use py.test as the test runner 2015-09-01 16:27: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.