Developers Love Docker. You rated Docker the #1 in 'Most Loved ' and #2 'Most Wanted' platform' in the 2019 StackOverflow Survey. But you also told us that Docker “Just works” is “better than chocolate cake” and is the “Best tool ever, I'm in love.” We love hearing how you love Docker. Oct 16, 2020 Docker Compose is a Python program that lets you easily deploy multiple containers on a server. As you start exploring Docker, you'll learn that often to run a certain web-app, you'll need to run various services (like database, web-server etc) in different containers.
Estimated reading time: 6 minutes
Looking for Compose file reference?Find the latest version here.
Compose is a tool for defining and running multi-container Docker applications.With Compose, you use a YAML file to configure your application’s services.Then, with a single command, you create and start all the servicesfrom your configuration. To learn more about all the features of Compose,see the list of features.
Compose works in all environments: production, staging, development, testing, aswell as CI workflows. You can learn more about each case in Common UseCases.
Using Compose is basically a three-step process:
Define your app’s environment with a
Dockerfile
so it can be reproducedanywhere.Define the services that make up your app in
docker-compose.yml
so they can be run together in an isolated environment.Run
docker compose up
and the Docker compose command starts and runs your entire app. You can alternatively rundocker-compose up
using the docker-compose binary.
A docker-compose.yml
looks like this:
For more information about the Compose file, see theCompose file reference.
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
Compose documentation
Features
The features of Compose that make it effective are:
Multiple isolated environments on a single host
Compose uses a project name to isolate environments from each other. You can make use of this project name in several different contexts:
- on a dev host, to create multiple copies of a single environment, such as when you want to run a stable copy for each feature branch of a project
- on a CI server, to keep builds from interfering with each other, you can setthe project name to a unique build number
- on a shared host or dev host, to prevent different projects, which may use thesame service names, from interfering with each other
The default project name is the basename of the project directory. You can seta custom project name by using the-p
command line option or theCOMPOSE_PROJECT_NAME
environment variable.
The default project directory is the base directory of the Compose file. A custom valuefor it can be defined with the --project-directory
command line option.
Preserve volume data when containers are created
Compose preserves all volumes used by your services. When docker-compose up
runs, if it finds any containers from previous runs, it copies the volumes fromthe old container to the new container. This process ensures that any datayou’ve created in volumes isn’t lost.
If you use docker-compose
on a Windows machine, seeEnvironment variables and adjust the necessary environmentvariables for your specific needs.
Only recreate containers that have changed
Compose caches the configuration used to create a container. When yourestart a service that has not changed, Compose re-uses the existingcontainers. Re-using containers means that you can make changes to yourenvironment very quickly.
Variables and moving a composition between environments
Compose supports variables in the Compose file. You can use these variablesto customize your composition for different environments, or different users.See Variable substitution for moredetails.
You can extend a Compose file using the extends
field or by creating multipleCompose files. See extends for more details.
Docker Get Docker Clothes
Common use cases
Compose can be used in many different ways. Some common use cases are outlinedbelow.
Development environments
When you’re developing software, the ability to run an application in anisolated environment and interact with it is crucial. The Compose commandline tool can be used to create the environment and interact with it.
The Compose file provides a way to document and configureall of the application’s service dependencies (databases, queues, caches,web service APIs, etc). Using the Compose command line tool you can createand start one or more containers for each dependency with a single command(docker-compose up
).
Together, these features provide a convenient way for developers to getstarted on a project. Compose can reduce a multi-page “developer gettingstarted guide” to a single machine readable Compose file and a few commands.
Automated testing environments
An important part of any Continuous Deployment or Continuous Integration processis the automated test suite. Automated end-to-end testing requires anenvironment in which to run tests. Compose provides a convenient way to createand destroy isolated testing environments for your test suite. By defining the full environment in a Compose file, you can create and destroy these environments in just a few commands:
Docker Get Dockerfile From Container
Single host deployments
Compose has traditionally been focused on development and testing workflows,but with each release we’re making progress on more production-oriented features.
For details on using production-oriented features, seecompose in production in this documentation.
Docker Get Dockerfile From Image
Release notes
To see a detailed list of changes for past and current releases of DockerCompose, refer to theCHANGELOG.
Docker List Docker Images
Getting help
Docker Compose is under active development. If you need help, would like tocontribute, or simply want to talk about the project with like-mindedindividuals, we have a number of open channels for communication.
Docker Get Docker Command
To report bugs or file feature requests: use the issue tracker on Github.
To talk about the project with people in real time: join the
#docker-compose
channel on the Docker Community Slack.To contribute code or documentation changes: submit a pull request on Github.