Define and run multi-container applications with Docker
Go to file
Joffrey F b9939c97e5 Don't leak circle API auth info
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-01-25 18:10:56 -08:00
.circleci Don't leak circle API auth info 2018-01-25 18:10:56 -08:00
bin
compose Don't break during recreate when a mount target is updated 2018-01-23 15:25:25 -08:00
contrib Add bash completion for `up {--always-recreate-deps,--renew-anon-volumes}` 2018-01-24 23:08:25 +01:00
docs
experimental
project
script Add circleCI build/test config for Mac OSX 2018-01-24 15:15:07 -08:00
tests Don't break during recreate when a mount target is updated 2018-01-23 15:25:25 -08:00
.dockerignore
.gitignore
.pre-commit-config.yaml
CHANGELOG.md
CHANGES.md
CONTRIBUTING.md
Dockerfile Update CLI version in test-running Dockerfiles 2018-01-18 12:22:52 -08:00
Dockerfile.armhf Update CLI version in test-running Dockerfiles 2018-01-18 12:22:52 -08:00
Dockerfile.run
Dockerfile.s390x
Jenkinsfile
LICENSE
MAINTAINERS
MANIFEST.in
README.md
SWARM.md
appveyor.yml
docker-compose.spec
logo.png
requirements-build.txt
requirements-dev.txt
requirements.txt
setup.cfg
setup.py
tox.ini

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.