Define and run multi-container applications with Docker
Go to file
Aanand Prasad bbc8b74c17 Merge pull request #2068 from mnowster/2037-jsonschema-resolver-windows-path-fix
Ensure RefResolver works across operating systems
2015-09-18 18:09:58 +01:00
bin
compose Merge pull request #2068 from mnowster/2037-jsonschema-resolver-windows-path-fix 2015-09-18 18:09:58 +01:00
contrib/completion Add bash completion for `docker-compose build --pull` 2015-09-18 18:12:30 +02:00
docs Merge pull request #2041 from ggtools/master 2015-09-18 16:49:05 +01:00
experimental
project
script Merge pull request #2065 from dnephin/use-dind-image 2015-09-18 16:10:41 +01:00
tests Merge pull request #2041 from ggtools/master 2015-09-18 16:49:05 +01:00
.dockerignore
.gitignore
.pre-commit-config.yaml
CHANGELOG.md Add 1.4.1 release notes and download instructions. 2015-09-15 18:03:17 -04:00
CHANGES.md
CONTRIBUTING.md
Dockerfile Trim the dockerfile and re-use the virtualenv we already have. 2015-09-17 18:46:29 -04:00
LICENSE
MAINTAINERS
MANIFEST.in Fix schema.json MANIFEST.in entry 2015-09-11 19:14:51 -03:00
README.md include logo in README 2015-09-15 09:17:00 +02:00
ROADMAP.md
SWARM.md
docker-compose.spec
logo.png include logo in README 2015-09-15 09:17:00 +02:00
requirements-build.txt
requirements-dev.txt
requirements.txt Update docker-py to 1.4.0 2015-09-11 15:42:20 -07:00
setup.py Update docker-py to 1.4.0 2015-09-11 15:42:20 -07:00
tox.ini Update scriptests/test-versions to work with daemon args, and move docker version constants into tests-versions. 2015-09-17 17:35:49 -04:00

README.md

Docker Compose

Docker Compose

(Previously known as Fig)

Compose is a tool for defining and running multi-container applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.

Compose is great for development environments, staging servers, and CI. We don't recommend that you use it in production yet.

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

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.