Development Status
- 5 - Production/Stable
Environment
- Console
Intended Audience
- Developers
License
- OSI Approved :: Apache Software License
Programming Language
- Python :: 3
- Python :: 3.4
- Python :: 3.6
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
Docker Compose
Docker Compose is a tool for running multi-container applications on Docker
defined using the Compose file format.
A Compose file is used to define how the one or more containers that make up
your application are configured.
Once you have a Compose file, you can create and start your application with a
single command: docker-compose up.
Compose files can be used to deploy applications locally, or to the cloud on Amazon ECS or Microsoft ACI using the Docker CLI. You can read more about how to do this:
Where to get Docker Compose
Windows and macOS
Docker Compose is included in Docker Desktop for Windows and macOS.
Linux
You can download Docker Compose binaries from the release page on this repository.
Using pip
If your platform is not supported, you can download Docker Compose using pip:
pip install docker-compose
Note: Docker Compose requires Python 3.6 or later.
Quick Start
Using Docker Compose is basically a three-step process:
- Define your app's environment with a
Dockerfileso it can be reproduced anywhere. - Define the services that make up your app in
docker-compose.ymlso they can be run together in an isolated environment. - Lastly, run
docker-compose upand Compose will start and run your entire app.
A Compose file looks like this:
services:
web:
build: .
ports:
- "5000:5000"
volumes:
- .:/code
redis:
image: redis
You can find examples of Compose applications in our Awesome Compose repository.
For more information about the Compose format, see the Compose file reference.
Contributing
Want to help develop Docker Compose? Check out our contributing documentation.
If you find an issue, please report it on the issue tracker.
Releasing
Releases are built by maintainers, following an outline of the release process.
Wheel compatibility matrix
Files in release
PyYAML
(<6,>=3.10)
distro
(<2,>=1.5.0)
docker[ssh]
(>=5)
dockerpty
(<1,>=0.4.1)
docopt
(<1,>=0.6.1)
jsonschema
(<4,>=2.5.1)
python-dotenv
(<1,>=0.13.0)
requests
(<3,>=2.20.0)
texttable
(<2,>=0.9.0)
websocket-client
(<1,>=0.32.0)
backports.ssl-match-hostname
(<4,>=3.5)
cached-property
(<2,>=1.2.0)
colorama
(<1,>=0.4)