Define and run multi-container applications with Docker
Go to file
Santiago M. Mola 0ea51906cd pass COMPOSE_PROJECT_NAME env var in container mode
Avoids the surprise of finding the project name set to the directory
name when COMPOSE_PROJECT_NAME is being used.

Signed-off-by: Santiago M. Mola <santi@mola.io>
2020-07-07 09:06:02 +02:00
.github Update maintainers and add CODEOWNERS for github 2019-11-22 16:00:07 +01:00
bin Removed Python2 support 2020-06-03 17:37:47 +02:00
compose Improve version help message 2020-07-06 11:10:31 +02:00
contrib Removed Python2 support 2020-06-03 17:37:47 +02: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 pass COMPOSE_PROJECT_NAME env var in container mode 2020-07-07 09:06:02 +02:00
tests Merge pull request #7031 from venthur/remove_python2 2020-06-10 17:03:19 +02:00
.dockerignore Use a simple script to get docker-ce releases 2020-01-08 10:15:48 +01:00
.gitignore Some additional exclusions in .gitignore / .dockerignore 2018-10-17 13:39:11 -07:00
.pre-commit-config.yaml Removed Python2 support 2020-06-03 17:37:47 +02:00
CHANGELOG.md [master] forward-port "Bump 1.26.1" 2020-07-02 12:57:46 +02: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 Merge pull request #7031 from venthur/remove_python2 2020-06-10 17:03:19 +02:00
Jenkinsfile General bumps 2020-04-27 17:34:36 +02:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Fix Typos 2020-05-20 18:30:57 -04:00
MANIFEST.in Pin all indirect dependencies 2020-06-04 13:43:27 +02:00
README.md README: Remove Python 2 deprecation message 2020-06-03 12:23:20 +02:00
Release.Jenkinsfile Enforce pip3 and python3 on Release Jenkins 2020-07-02 18:06:08 +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
docker-compose-entrypoint.sh Refactor Dockerfiles for generating musl binaries 2019-04-17 16:08:33 +02:00
docker-compose.spec Fix v3.8 schema support for binaries 2020-03-05 15:46:45 +01:00
docker-compose_darwin.spec Fix v3.8 schema support for binaries 2020-03-05 15:46:45 +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 5.0.3 to 5.1 2020-06-23 04:37:58 +02:00
requirements-indirect.txt Bump py from 1.8.1 to 1.8.2 2020-06-23 04:37:35 +02:00
requirements.txt Merge pull request #7563 from aiordache/validate_context_endpoint 2020-06-30 18:46:57 +02:00
setup.cfg enable universal wheels 2017-01-04 18:33:58 +00:00
setup.py setyp.py: fix minimum docker-py requirement to 4.2.2 2020-07-02 12:50:15 +02:00
tox.ini Merge pull request #7031 from venthur/remove_python2 2020-06-10 17:03:19 +02: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

  • 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.