Define and run multi-container applications with Docker
Go to file
Mazz Mosley 8efc39e616 Improve boolean warning message.
Including examples of more boolean types, eg yes/N as it's not
always immediately clear that they are treated as booleans.

Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com>
2015-10-07 14:59:08 +01:00
bin
compose Improve boolean warning message. 2015-10-07 14:59:08 +01:00
contrib/completion Merge pull request #2032 from villlem/master 2015-09-21 13:41:08 +01:00
docs Merge pull request #2126 from mnowster/1188-support-ro-options-in-volumes-from 2015-10-07 11:57:14 +01:00
experimental
project Restore notes about building non-linux binaries. 2015-10-02 11:25:16 -04:00
script Test against a list of versions generated from docker/docker tags. 2015-10-06 10:51:52 -04:00
tests Improve boolean warning message. 2015-10-07 14:59:08 +01:00
.dockerignore alpine docker image for running compose and a script to pull and run it with the 2015-10-02 11:38:35 -04:00
.gitignore Configure PyInstaller using docker-compose.spec 2015-09-02 17:47:14 -07:00
.pre-commit-config.yaml Add more github label areas. 2015-09-08 19:44:25 -04:00
CHANGELOG.md Bump 1.4.2 2015-09-23 14:24:13 -04:00
CHANGES.md
CONTRIBUTING.md Running a single test command updated 2015-09-04 17:23:22 +01:00
Dockerfile Trim the dockerfile and re-use the virtualenv we already have. 2015-09-17 18:46:29 -04:00
Dockerfile.run alpine docker image for running compose and a script to pull and run it with the 2015-10-02 11:38:35 -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
appveyor.yml Fix building the binary on appveyor, and have it create an artifact. 2015-09-23 10:40:28 -04:00
docker-compose.spec Bundle schema files 2015-09-02 18:09:34 -07:00
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 Pass all DOCKER_ env vars to py.test 2015-10-01 12:26:58 +01: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.