Define and run multi-container applications with Docker
Go to file
Harald Albers 7e22719090 Fix suppressed blank in completion of `scale --help`
Wrong placement of `compopt -o` introduces an unexpected behavior that did
not matter as long as --help was the only option (you would probably not
continue to type after --help): completion of options would not automatically
append a whitespace character as expected.

For the outstanding addition of the --timeout option, which has an
argument, this would mean that the user would have to type an extra
whitespace after completion of --timeout before the argument could be
added.

Signed-off-by: Harald Albers <github@albersweb.de>
2015-08-26 18:20:17 +02:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Fix service integration tests. 2015-08-25 10:48:48 -04:00
contrib/completion Fix suppressed blank in completion of `scale --help` 2015-08-26 18:20:17 +02:00
docs Run pre-commit on all files 2015-08-24 17:04:50 -04:00
experimental Fixes 2015-06-22 08:44:41 -07:00
script Cleanup requirements.txt so we don't have to maintain separate copies for py2 and py3. 2015-08-25 10:46:08 -04:00
tests Fix service integration tests. 2015-08-25 10:48:48 -04:00
.dockerignore Add test coverage support 2015-07-15 10:09:37 +01:00
.gitignore Add test coverage support 2015-07-15 10:09:37 +01: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 Link to waffle board from CONTRIBUTING.md 2015-07-15 11:56:46 +01:00
Dockerfile Python3 requires a locale 2015-08-25 11:10:02 -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
RELEASE_PROCESS.md Fill out release process documentation 2015-08-12 16:31:37 +01: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
requirements-dev.txt Python3 requires a locale 2015-08-25 11:10:02 -04:00
requirements.txt Run pre-commit on all files 2015-08-24 17:04:50 -04:00
setup.py Cleanup requirements.txt so we don't have to maintain separate copies for py2 and py3. 2015-08-25 10:46:08 -04:00
tox.ini 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

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.