Define and run multi-container applications with Docker
Go to file
Harald Albers 20a9ae50b0 Refactor bash completion for services
Signed-off-by: Harald Albers <github@albersweb.de>
2018-04-11 12:47:10 +02:00
.circleci pip3? 2018-03-20 15:10:49 +01:00
bin Use newer versions of pre-commit hooks 2017-08-02 20:02:26 -07:00
compose Make sure error messages are unicode strings before combining 2018-04-09 11:46:33 -07:00
contrib Refactor bash completion for services 2018-04-11 12:47:10 +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 Better installation instruction in release notes 2017-10-23 14:41:10 -07:00
script Merge branch 'release' 2018-03-20 16:08:34 +01:00
tests Make sure error messages are unicode strings before combining 2018-04-09 11:46:33 -07:00
.dockerignore Some more test adjustments for Swarm support 2017-07-20 16:39:03 -07:00
.gitignore Handle giving help a nonexistent command 2016-12-03 14:58:15 -05:00
.pre-commit-config.yaml Use newer versions of pre-commit hooks 2017-08-02 20:02:26 -07:00
CHANGELOG.md 1.21.0-dev 2018-03-20 16:10:08 +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 Remove obsolete code that slows down test execution 2018-02-02 15:18:55 -08:00
Dockerfile.armhf Test and build on 3.6 (replaces 3.4) ; dist 3.6-compiled binaries 2018-02-01 16:05:32 -08:00
Dockerfile.run Add libgcc dependency for Compose in a container 2018-03-23 14:08:06 +01:00
Dockerfile.s390x Use slim alpine instead of bulky debian 2017-09-26 17:44:22 -07:00
Jenkinsfile Parallelize Docker versions 2018-02-02 17:38:33 -08:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Fix indentation + HOF comment 2018-03-15 12:20:00 -07:00
MANIFEST.in Add the git sha to version output 2015-11-18 13:21:14 -05:00
README.md Improve spelling in the README.md 2018-02-07 10:54:41 -08: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 Test and build on 3.6 (replaces 3.4) ; dist 3.6-compiled binaries 2018-02-01 16:05:32 -08:00
docker-compose.spec Add 2.4 file format with platform support. Also reads DOCKER_DEFAULT_PLATFORM env 2018-03-30 12:39:10 -07: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 Test and build on 3.6 (replaces 3.4) ; dist 3.6-compiled binaries 2018-02-01 16:05:32 -08:00
requirements.txt Bump SDK -> 3.2.1 2018-03-30 11:30:13 -07:00
setup.cfg enable universal wheels 2017-01-04 18:33:58 +00:00
setup.py Bump SDK -> 3.2.1 2018-03-30 11:30:13 -07:00
tox.ini Test and build on 3.6 (replaces 3.4) ; dist 3.6-compiled binaries 2018-02-01 16:05:32 -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.