Define and run multi-container applications with Docker
Go to file
Ian Campbell dc9184a90f progress_stream: Avoid undefined ANSI escape codes
The ANSI escape codes \e[0A (cursor up 0 lines) and \e[0B (cursor down 0 lines)
are not well defined and are treated differently by different terminals. In
particular xterm treats 0 as a missing parameter and therefore defaults to 1,
whereas rxvt-unicode treats these escapes as a request to move 0 lines.

However the use of these codes is unnecessary and were really just hiding the
fact that we were not correctly computing diff when adding a new line. Having
added the new line to the ids map and output the corresponding \n the correct
diff would be 1 and not 0 (which xterm interprets as 1) as currently.

Rather than changing the hardcoded 0 to a 1 pull the diff calculation out and
always do it since it produces the correct answer in both cases.

This fixes similar corruption when compose is pulling an image to that seen
with `docker pull` and rxvt-unicode (and likely other terminals in that family)
seen in docker/docker#28111.

This is the same as the fix made to Docker's pkg/jsonmessage in
https://github.com/docker/docker/pull/28238 (and I have shamelessly ripped off
most of this commit message from there).

Signed-off-by: Ian Campbell <ian.campbell@docker.com>
2016-11-25 10:16:37 +00:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose progress_stream: Avoid undefined ANSI escape codes 2016-11-25 10:16:37 +00:00
contrib Shell completion for --push-images 2016-07-27 16:00:53 +01:00
docs updated README per vnext branch plan 2016-10-05 16:19:09 -07:00
experimental Remove doc on experimental networking support 2016-07-25 13:38:04 +01:00
project Build osx binary on travis and upload to bintray. 2016-03-01 11:34:54 -05:00
script case PyPI correctly 2016-11-22 11:15:21 +00:00
tests Use stop grace period for container stop. 2016-11-16 12:12:28 -05:00
.dockerignore alpine docker image for running compose and a script to pull and run it with the 2015-10-02 11:38:35 -04:00
.gitignore Ignore extra coverge files 2015-12-10 15:29:36 -08:00
.pre-commit-config.yaml Tests use updated get_config_paths_from_options signature 2016-03-24 10:57:01 -07:00
.travis.yml Build osx binary on travis and upload to bintray. 2016-03-01 11:34:54 -05:00
CHANGELOG.md case PyPI correctly 2016-11-22 11:15:21 +00:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Convert readthedocs links for their .org -> .io migration for hosted projects 2016-06-08 03:52:12 +01:00
Dockerfile Upgade pip to latest 2016-04-26 11:58:41 -04:00
Dockerfile.run Pin base image to alpine:3.4 in Dockerfile.run 2016-07-06 18:01:27 -07:00
Jenkinsfile Limit testing pool to Ubuntu hosts to avoid errors with dind not 2016-11-14 17:23:25 -08:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS update maintainers file for parsing 2015-12-04 16:52:29 +01:00
MANIFEST.in Add the git sha to version output 2015-11-18 13:21:14 -05:00
README.md fix(docs): updated documentation links 2016-10-24 15:41:31 +01:00
ROADMAP.md Prevent unnecessary inspection of containers when created from an inspect. 2016-04-06 11:14:42 -04:00
SWARM.md Update Swarm integration guide and make it an official part of the docs 2016-02-19 09:32:43 -08:00
appveyor.yml Move all build scripts to script/build 2016-02-24 16:24:13 -08:00
docker-compose.spec Add missing config schema to docker-compose.spec 2016-10-24 10:55:04 -07:00
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt Upgrade pyinstaller. 2016-02-11 13:50:41 -05:00
requirements-dev.txt Use py.test as the test runner 2015-09-01 16:27:44 -04:00
requirements.txt Updated docker-py dependency to latest version 2016-11-02 16:56:45 -07:00
setup.py Updated docker-py dependency to latest version 2016-11-02 16:56:45 -07:00
tox.ini Merge pull request #2388 from dnephin/fix_long_lines 2016-02-25 16:52:33 -08:00

README.md

Docker Compose

Docker Compose

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a Compose file to configure your application's services. Then, using a single command, you create and start all the services from your configuration. To learn more about all the features of Compose see the list of features.

Compose is great for development, testing, and staging environments, as well as CI workflows. You can learn more about each case in Common Use Cases.

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:

version: '2'

services:
  web:
    build: .
    ports:
     - "5000:5000"
    volumes:
     - .:/code
  redis:
    image: redis

For more information about the Compose file, see the Compose file reference

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.