mirror of https://github.com/docker/compose.git
c907f35e74
Check for this in the init so we can remove the duplication of raising in further functions. A ServiceLoader isn't valid without one. Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com> |
||
---|---|---|
bin | ||
compose | ||
contrib/completion | ||
docs | ||
experimental | ||
project | ||
script | ||
tests | ||
.dockerignore | ||
.gitignore | ||
.pre-commit-config.yaml | ||
CHANGELOG.md | ||
CHANGES.md | ||
CONTRIBUTING.md | ||
Dockerfile | ||
LICENSE | ||
MAINTAINERS | ||
MANIFEST.in | ||
README.md | ||
ROADMAP.md | ||
SWARM.md | ||
requirements-build.txt | ||
requirements-dev.txt | ||
requirements.txt | ||
setup.py | ||
tox.ini |
README.md
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.
- Define your app's environment with a
Dockerfile
so it can be reproduced anywhere. - Define the services that make up your app in
docker-compose.yml
so they can be run together in an isolated environment: - 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
- Full documentation is available on Docker's website.
- If you have any questions, you can talk in real-time with other developers in the #docker-compose IRC channel on Freenode. Click here to join using IRCCloud.
Contributing
Want to help build Compose? Check out our contributing documentation.
Releasing
Releases are built by maintainers, following an outline of the release process.