Define and run multi-container applications with Docker
Go to file
Daniel Nephin 3474bb6cf5 Cleanup workaround in testcase.py
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2015-11-10 12:43:55 -05:00
bin
compose Merge pull request #2339 from dnephin/recreate_deps_on_create 2015-11-10 17:36:23 +00:00
contrib/completion
docs Cherry-pick release notes froim 1.5.0 2015-11-05 10:25:46 -05:00
experimental
project
script Fix rebase-bump-commit script when used with a final release. 2015-11-05 10:25:46 -05:00
tests Cleanup workaround in testcase.py 2015-11-10 12:43:55 -05:00
.dockerignore
.gitignore
.pre-commit-config.yaml
.travis.yml
CHANGELOG.md Cherry-pick release notes froim 1.5.0 2015-11-05 10:25:46 -05:00
CHANGES.md
CONTRIBUTING.md
Dockerfile Fix jenkins CI by using an older docker version to match the host. 2015-11-04 15:33:37 -05:00
Dockerfile.run
LICENSE
MAINTAINERS
MANIFEST.in
README.md Touch up intro paragraph with feedback from @moxiegirl. 2015-11-02 15:16:23 -05:00
ROADMAP.md
SWARM.md
appveyor.yml
docker-compose.spec
logo.png
requirements-build.txt
requirements-dev.txt
requirements.txt Upgrade pyyaml to 3.11 2015-11-05 10:26:54 -05:00
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:

web:
  build: .
  ports:
   - "5000:5000"
  volumes:
   - .:/code
  links:
   - redis
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.