Define and run multi-container applications with Docker
Go to file
Ulysses Souza 36790fc0e8
Merge pull request #7058 from docker/dependabot/pip/idna-2.8
Bump idna from 2.5 to 2.8
2020-01-08 16:00:45 +01:00
.github Update maintainers and add CODEOWNERS for github 2019-11-22 16:00:07 +01:00
bin
compose Merge pull request #7093 from ulyssessouza/warn-invalid-version 2020-01-08 10:47:01 +01:00
contrib
docs
experimental
project
pyinstaller
script Generate changelog 2020-01-08 10:15:48 +01:00
tests Merge pull request #7093 from ulyssessouza/warn-invalid-version 2020-01-08 10:47:01 +01:00
.dockerignore Use a simple script to get docker-ce releases 2020-01-08 10:15:48 +01:00
.fossa.yml
.gitignore
.pre-commit-config.yaml
CHANGELOG.md "Bump 1.25.1" 2020-01-06 17:42:50 +01:00
CHANGES.md
CONTRIBUTING.md
Dockerfile
Dockerfile.s390x
Jenkinsfile TAG and BUILD_TAG are obsolete 2020-01-08 10:15:48 +01:00
LICENSE
MAINTAINERS Update maintainers and add CODEOWNERS for github 2019-11-22 16:00:07 +01:00
MANIFEST.in
README.md Announce drop py2 2019-11-21 13:23:56 +01:00
Release.Jenkinsfile publish package on PyPI 2020-01-08 10:15:48 +01:00
SWARM.md
docker-compose-entrypoint.sh
docker-compose.spec
docker-compose_darwin.spec Build OSX binary as a directory 2019-11-21 09:01:41 +01:00
logo.png
requirements-build.txt
requirements-dev.txt Bump ddt from 1.2.0 to 1.2.2 2019-12-04 07:10:30 +00:00
requirements.txt Merge pull request #7058 from docker/dependabot/pip/idna-2.8 2020-01-08 16:00:45 +01:00
setup.cfg
setup.py Use python Posix support to get tty size 2019-10-16 14:31:27 +02:00
tox.ini

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.