Define and run multi-container applications with Docker
Go to file
Veres Lajos 11adca9324 typofix - https://github.com/vlajos/misspell_fixer
Signed-off-by: Veres Lajos <vlajos@gmail.com>
2015-08-07 22:34:24 +01:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Show a warning when a variable is unset 2015-08-06 14:24:11 +01:00
contrib/completion Deprecate --allow-insecure-ssl 2015-07-23 10:56:21 +01:00
docs Interpolate environment variables 2015-08-06 11:18:57 +01:00
experimental Fixes 2015-06-22 08:44:41 -07:00
script Abort tests if daemon fails to start 2015-08-06 14:45:35 +01:00
tests typofix - https://github.com/vlajos/misspell_fixer 2015-08-07 22:34:24 +01: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
CHANGES.md Update CHANGES.md and install.md for latest stable version 2015-07-23 11:09:27 +01:00
CONTRIBUTING.md Link to waffle board from CONTRIBUTING.md 2015-07-15 11:56:46 +01:00
Dockerfile Update API version to 1.19 2015-07-29 15:44:21 +01: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 add all completions to sdist 2015-07-22 21:17:15 -05:00
README.md Split out release process 2015-07-01 15:58:11 +01:00
RELEASE_PROCESS.md Don't use future tense 2015-07-01 18:06:09 +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 Add test coverage support 2015-07-15 10:09:37 +01:00
requirements.txt Update docker-py to 1.3.1 2015-07-23 10:56:21 +01:00
setup.py Update docker-py to 1.3.1 2015-07-23 10:56:21 +01:00
tox.ini make flake8 a bit more specific 2015-03-26 09:09:15 -07: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.