Define and run multi-container applications with Docker
Go to file
Joffrey F fee5261014 Always connect Compose container to stdin
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-12-19 00:24:33 -08:00
.circleci Bump Python SDK -> 3.5.0 2018-08-09 18:31:08 -07:00
.github/ISSUE_TEMPLATE Update issue templates 2018-10-16 18:18:21 -07:00
bin Use newer versions of pre-commit hooks 2017-08-02 20:02:26 -07:00
compose Style and language fixes 2018-12-14 14:36:40 -08:00
contrib Fix ZSH autocomplete for multiple -f flags 2018-11-03 18:37:34 +02:00
docs missing "is" 2018-03-23 18:03:08 +01:00
experimental Remove doc on experimental networking support 2016-07-25 13:38:04 +01:00
project Document new release process 2018-04-23 14:52:15 -07:00
script Always connect Compose container to stdin 2018-12-19 00:24:33 -08:00
tests Merge branch 'feature/reject_environment_variable_that_contains_white_spaces' of https://github.com/hirochachacha/compose into hirochachacha-feature/reject_environment_variable_that_contains_white_spaces 2018-12-14 13:42:05 -08:00
.dockerignore Some additional exclusions in .gitignore / .dockerignore 2018-10-17 13:39:11 -07:00
.gitignore Some additional exclusions in .gitignore / .dockerignore 2018-10-17 13:39:11 -07:00
.pre-commit-config.yaml Update `reorder_python_imports` version to fix Unicode problems 2018-12-01 00:35:34 +01:00
CHANGELOG.md "Bump 1.23.2" 2018-11-28 14:26:26 -08:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Keep CONTRIBUTING.md information up to date 2018-02-12 12:06:37 -08:00
Dockerfile Remove obsolete curl dependency 2018-10-15 19:22:25 -07:00
Dockerfile.armhf [armhf] Make Dockerfile.armhf compatible with main 2018-09-05 11:52:50 -03:00
Dockerfile.run Update versions in Dockerfiles 2018-10-15 19:14:58 -07:00
Dockerfile.s390x Use slim alpine instead of bulky debian 2017-09-26 17:44:22 -07:00
Jenkinsfile Bump Python SDK -> 3.5.0 2018-08-09 18:31:08 -07:00
LICENSE
MAINTAINERS Fix indentation + HOF comment 2018-03-15 12:20:00 -07:00
MANIFEST.in Update setup.py for modern pypi /setuptools 2018-11-30 17:59:55 -08:00
README.md README.md: Update bug report link 2018-11-27 00:26:56 +01: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 Bump Python SDK -> 3.5.0 2018-08-09 18:31:08 -07:00
docker-compose.spec Add composefile v3.7 2018-05-29 11:58:54 +02:00
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt Test and build on 3.6 (replaces 3.4) ; dist 3.6-compiled binaries 2018-02-01 16:05:32 -08:00
requirements-dev.txt Bump Python SDK -> 3.5.0 2018-08-09 18:31:08 -07:00
requirements.txt Add SSH-enabled docker SDK to requirements 2018-11-30 16:24:38 -08:00
setup.cfg enable universal wheels 2017-01-04 18:33:58 +00:00
setup.py Update setup.py for modern pypi /setuptools 2018-11-30 17:59:55 -08:00
tox.ini Bump Python SDK -> 3.5.0 2018-08-09 18:31:08 -07: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

  • Full documentation is available on Docker's website.
  • Code repository for Compose is on GitHub.
  • If you find any problems please fill out an issue. Thank you!

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.