Define and run multi-container applications with Docker
Go to file
Joffrey F 8c4af54257 Bump 1.20.0-rc2
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-03-08 18:34:23 -08:00
.circleci Install both versions of python 2018-03-08 18:34:23 -08:00
bin
compose Bump 1.20.0-rc2 2018-03-08 18:34:23 -08:00
contrib Add support for options added in 1.20.0 to bash completion 2018-03-08 18:29:09 -08:00
docs
experimental
project Better installation instruction in release notes 2017-10-23 14:41:10 -07:00
script Bump 1.20.0-rc2 2018-03-08 18:34:23 -08:00
tests Preserve security_opt values in extends 2018-03-08 18:29:22 -08:00
.dockerignore
.gitignore
.pre-commit-config.yaml
CHANGELOG.md Bump 1.20.0-rc2 2018-03-08 18:34:23 -08:00
CHANGES.md
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 Update Dockerfile.run to produce smaller image 2018-03-08 18:34:23 -08:00
Dockerfile.s390x
Jenkinsfile Parallelize Docker versions 2018-02-02 17:38:33 -08:00
LICENSE
MAINTAINERS
MANIFEST.in
README.md Improve spelling in the README.md 2018-02-03 17:31:22 +02:00
SWARM.md
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 support for 3.6 schema and tmpfs mount size 2018-02-02 12:01:41 -08:00
logo.png
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 SDK version 3.1.1 2018-03-08 18:29:14 -08:00
setup.cfg
setup.py SDK version 3.1.1 2018-03-08 18:29:14 -08: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.