Define and run multi-container applications with Docker
Go to file
Ulysses Souza 9e3d9f6681 Update release process on updating docs
Signed-off-by: Ulysses Souza <ulysses.souza@docker.com>
2019-04-04 11:51:12 +02:00
.circleci Bump python version from 3.6.8 to 3.7.2 2019-02-21 13:56:45 +01: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 "Bump 1.24.0" 2019-03-28 19:38:25 +01:00
contrib Add --quiet build flag 2019-03-02 13:07:23 +05:30
docs docs/README.md: update since `vnext-compose` branch is no longer used. 2019-03-06 10:37:32 +00: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 Update release process on updating docs 2019-04-04 11:51:12 +02:00
tests Merge pull request #6592 from treatwell/6589-depends_on-recreation-fix 2019-03-26 14:06:14 +00: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.24.0" 2019-03-28 19:38:25 +01: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 Harmonize tox and virtualenv versions 2019-02-21 13:56:45 +01:00
Dockerfile.armhf Bump python version from 3.6.8 to 3.7.2 2019-02-21 13:56:45 +01: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 version from 3.6.8 to 3.7.2 2019-02-21 13:56:45 +01:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Update maintainers file 2019-01-14 15:22:12 -08: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 Harmonize tox and virtualenv versions 2019-02-21 13:56:45 +01:00
docker-compose.spec Enable bootloader_ignore_signals in pyinstaller 2019-03-12 12:25:35 -04:00
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt Bump python version from 3.6.8 to 3.7.2 2019-02-21 13:56:45 +01:00
requirements-dev.txt requirements-dev: Fix version of mock to 2.0.0 2019-02-05 10:50:25 +01:00
requirements.txt Bump docker-py 3.7.2 2019-03-28 17:45:03 +01:00
setup.cfg enable universal wheels 2017-01-04 18:33:58 +00:00
setup.py Merge pull request #6444 from qboot/master 2019-01-10 16:31:29 -08:00
tox.ini Bump python version from 3.6.8 to 3.7.2 2019-02-21 13:56:45 +01: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.