Define and run multi-container applications with Docker
Go to file
Anca Iordache 0ab351d71e test update - remove 'placement' from unsupported fields
Signed-off-by: Anca Iordache <anca.iordache@docker.com>
(cherry picked from commit 09c80ce49b)
2020-04-08 17:16:01 +02:00
.github Update maintainers and add CODEOWNERS for github 2019-11-22 16:00:07 +01:00
bin Use newer versions of pre-commit hooks 2017-08-02 20:02:26 -07:00
compose Add v3.8 schema support 2020-04-08 17:15:38 +02:00
contrib Support attaching to dependencies on up 2020-01-16 13:41:54 +00:00
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
pyinstaller Refactor Dockerfiles for generating musl binaries 2019-04-17 16:08:33 +02:00
script Bump version to 1.25.4 2020-02-03 09:53:27 +01:00
tests test update - remove 'placement' from unsupported fields 2020-04-08 17:16:01 +02:00
.dockerignore Use a simple script to get docker-ce releases 2020-01-08 10:15:48 +01:00
.fossa.yml Add .fossa.yml file 2019-06-14 14:58:17 +01: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.25.1" 2020-01-06 17:42:50 +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 Bump Linux dependencies 2020-01-15 10:54:57 +01:00
Dockerfile.s390x update alpine version to 3.10.1 2019-08-20 12:10:26 +02:00
Jenkinsfile update public CI so we run tests on same combinations of python+docker 2020-01-09 16:15:34 +01:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Update maintainers and add CODEOWNERS for github 2019-11-22 16:00:07 +01:00
MANIFEST.in Update setup.py for modern pypi /setuptools 2018-11-30 17:59:55 -08:00
README.md Announce drop py2 2019-11-21 13:23:56 +01:00
Release.Jenkinsfile Force MacOS SDK version to "10.11" 2020-01-30 15:56:25 +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
docker-compose-entrypoint.sh Refactor Dockerfiles for generating musl binaries 2019-04-17 16:08:33 +02:00
docker-compose.spec Enable bootloader_ignore_signals in pyinstaller 2019-03-12 12:25:35 -04:00
docker-compose_darwin.spec Build OSX binary as a directory 2019-11-21 09:01:41 +01:00
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt Bump pyinstaller to 3.6 2020-01-16 13:46:47 +01:00
requirements-dev.txt Bump coverage from 4.5.4 to 5.0.3 2020-01-13 13:33:13 +00:00
requirements.txt Merge pull request #7140 from docker/dependabot/pip/cached-property-1.5.1 2020-01-14 19:50:31 +01:00
setup.cfg enable universal wheels 2017-01-04 18:33:58 +00:00
setup.py support PyYAML up to 5.x version 2020-01-09 12:30:51 +01: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

The docker-compose project announces that as Python 2 reaches it's EOL, versions 1.25.x will be the last to support it. For more information, please refer to this issue.

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.