Define and run multi-container applications with Docker
Go to file
Ben Firshman e3eccd1047 Merge pull request #979 from aanand/fix-env-docs
Update environment variable names in docs
2015-02-19 14:34:48 +00:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Update pep8, fix errors and freeze requirements-dev.txt 2015-02-11 19:00:13 +00:00
contrib/completion/bash Merge pull request #887 from albers/multiple-configfiles 2015-01-27 23:08:23 -05:00
docs Merge pull request #979 from aanand/fix-env-docs 2015-02-19 14:34:48 +00:00
script Fix typos 2015-01-20 21:28:49 +00:00
tests Merge pull request #898 from aanand/support-fig-yml 2015-01-29 13:47:49 -05:00
.dockerignore Add .dockerignore 2014-10-23 19:00:44 +01:00
.gitignore Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
CHANGES.md Add missing cpu_shares option for rel. 1.1.0-rc1 2015-02-01 17:03:50 +01:00
CONTRIBUTING.md Tidy up contributing guidelines 2015-02-12 13:40:02 +00:00
Dockerfile Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Remove @nathanleclaire as a maintainer 2015-02-12 16:39:59 +00:00
MANIFEST.in Add tests to sdist. 2014-11-28 09:37:33 -06:00
README.md Rejig introduction 2015-02-17 10:58:51 +00:00
ROADMAP.md Update README.md, ROADMAP.md and CONTRIBUTING.md 2015-01-20 21:00:23 +00:00
requirements-dev.txt Update pep8, fix errors and freeze requirements-dev.txt 2015-02-11 19:00:13 +00:00
requirements.txt Use latest docker-py. 2015-01-25 15:33:15 -05:00
setup.py Use latest docker-py. 2015-01-25 15:33:15 -05:00
tox.ini Some minor cleanup from yelp/fig 2014-12-11 10:08:39 -08:00
wercker.yml Run pyinstaller build as normal user 2014-09-30 16:25:40 -07:00

README.md

Docker Compose

wercker status

Compose is a tool for defining and running complex 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.

First, you define your app's environment with a Dockerfile so it can be reproduced anywhere:

FROM python:2.7
WORKDIR /code
ADD requirements.txt /code/
RUN pip install -r requirements.txt
ADD . /code
CMD python app.py

Next, you define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment:

web:
  build: .
  links:
   - db
  ports:
   - "8000:8000"
db:
  image: postgres

Lastly, run docker-compose up and Compose will start and run your entire app.

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 Fig's website.