No Description

Daniel Nephin 514f0650b2 Give the user a better error message (without a stack trace) when there is a yaml error. 10 years ago
bin 620e29b63f Rename binary to docker-compose and config file to docker-compose.yml 10 years ago
compose 514f0650b2 Give the user a better error message (without a stack trace) when there is a yaml error. 10 years ago
contrib 20d34c8b14 Add zsh completion for 'docker-compose --x-networking --x-network-driver' 10 years ago
docs 49b98fa111 Attempt to document escaping env vars 10 years ago
experimental 52975eca6f Fixes 10 years ago
project b2f9c182f3 Fix some release docs. 10 years ago
script 284cda087e Add missing merge for release branch. 10 years ago
tests 514f0650b2 Give the user a better error message (without a stack trace) when there is a yaml error. 10 years ago
.dockerignore 39cea970b8 alpine docker image for running compose and a script to pull and run it with the 10 years ago
.gitignore b165ae07c9 Configure PyInstaller using docker-compose.spec 10 years ago
.pre-commit-config.yaml 9ce1884925 Add upload to bintray from travis. 10 years ago
.travis.yml 9ce1884925 Add upload to bintray from travis. 10 years ago
CHANGELOG.md 709bd9c363 Bump 1.5.0rc1 10 years ago
CHANGES.md 478054af47 Rename CHANGES.md to CHANGELOG.md 10 years ago
CONTRIBUTING.md 31e8137452 Running a single test command updated 10 years ago
Dockerfile 8b29a50b52 Trim the dockerfile and re-use the virtualenv we already have. 10 years ago
Dockerfile.run 4ae2a0e610 Update release scripts for release image. 10 years ago
LICENSE 99064d17dd Docker, Inc. 11 years ago
MAINTAINERS 63941b8f6c Add Mazz to MAINTAINERS 10 years ago
MANIFEST.in 1fcacae1fe Fix schema.json MANIFEST.in entry 10 years ago
README.md 49ca23c034 Fix link to Release Process doc in README.md 10 years ago
ROADMAP.md 41406cdd68 Update roadmap with state convergence 10 years ago
SWARM.md c421d23c34 Update Swarm docs 10 years ago
appveyor.yml 0e9ec8aa74 Add publish to bintray step to appveyor.yml 10 years ago
docker-compose.spec ecea79fd4e Bundle schema files 10 years ago
logo.png 0bdbb33447 include logo in README 10 years ago
requirements-build.txt 6ac617bae1 Split requirements-build.txt from requirements-dev.txt to support a leaner tox.ini 10 years ago
requirements-dev.txt c1ed1efde8 Use py.test as the test runner 10 years ago
requirements.txt 7c6e7e0dce Update docker-py to 1.5.0 10 years ago
setup.py 7c6e7e0dce Update docker-py to 1.5.0 10 years ago
tox.ini d5f5eb1924 Enable use of Docker networking with the --x-networking flag 10 years ago

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.