Define and run multi-container applications with Docker
Go to file
Alexander 9d7202d122 Squashed commit of the following:
commit d3fbd3d630099dc0d34cb1a93b0a664f633a1c25
Author: zasca <gorstav@gmail.com>
Date:   Wed Oct 3 11:27:43 2018 +0600

    Fix typo in function name, path separator updated

commit bc3f03cd9a7702b3f2d96b18380d75e10f18def0
Author: zasca <gorstav@gmail.com>
Date:   Tue Oct 2 11:12:28 2018 +0600

    Fix endswith arg in the test

commit 602d2977b4e881850c99c7555bc284690a802815
Author: zasca <gorstav@gmail.com>
Date:   Mon Oct 1 12:24:17 2018 +0600

    Update test

commit 6cd7a4a2c411ddf9b8e7d91194c60fb2238db8d7
Author: zasca <gorstav@gmail.com>
Date:   Fri Sep 28 11:13:36 2018 +0600

    Fix last test

commit 0d37343433caceec18ea15babf924b5975b83c80
Author: zasca <gorstav@gmail.com>
Date:   Fri Sep 28 10:58:57 2018 +0600

    Unit test added

commit fc086e544677dd33bad798c773cb92600aaefc51
Author: zasca <gorstav@gmail.com>
Date:   Thu Sep 27 20:28:03 2018 +0600

    Improved expanding source paths of volumes

    defined with long syntax when paths starts with '~'

    Signed-off-by: Alexander <a.gorst.vinia@gmail.com>
2018-10-05 14:52:56 +06:00
.circleci Bump Python SDK -> 3.5.0 2018-08-09 18:31:08 -07:00
bin Use newer versions of pre-commit hooks 2017-08-02 20:02:26 -07:00
compose Squashed commit of the following: 2018-10-05 14:52:56 +06:00
contrib Update zsh completion with new options, and ensure service names are properly retrieved 2018-09-12 16:17:30 -07: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 Avoid cred helpers errors in release script 2018-09-26 13:58:13 -07:00
tests Squashed commit of the following: 2018-10-05 14:52:56 +06:00
.dockerignore Some more test adjustments for Swarm support 2017-07-20 16:39:03 -07:00
.gitignore Add --hash opt for config command 2018-08-07 16:51:01 -07:00
.pre-commit-config.yaml Use newer versions of pre-commit hooks 2017-08-02 20:02:26 -07:00
CHANGELOG.md Fix typos in CHANGELOG 2018-09-07 16:42:38 +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 code that slows down test execution 2018-02-02 15:18:55 -08:00
Dockerfile.armhf [armhf] Make Dockerfile.armhf compatible with main 2018-09-05 11:52:50 -03:00
Dockerfile.run Fix broken url 2018-08-17 14:08:41 -03: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 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-03 17:31:22 +02: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 Bump Python SDK -> 3.5.0 2018-08-09 18:31:08 -07:00
setup.cfg enable universal wheels 2017-01-04 18:33:58 +00:00
setup.py Bump Python SDK -> 3.5.0 2018-08-09 18:31:08 -07: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

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.