mirror of
https://github.com/docker/compose.git
synced 2025-07-23 05:34:36 +02:00
Merge pull request #7906 from chris-crone/cloud-readme
Simplify README and add cloud deployment
This commit is contained in:
commit
843621dfb8
106
README.md
106
README.md
@ -1,62 +1,86 @@
|
|||||||
Docker Compose
|
Docker Compose
|
||||||
==============
|
==============
|
||||||
|
[](https://ci-next.docker.com/public/job/compose/job/master/)
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Compose is a tool for defining and running multi-container Docker applications.
|
Docker Compose is a tool for running multi-container applications on Docker
|
||||||
With Compose, you use a Compose file to configure your application's services.
|
defined using the [Compose file format](https://compose-spec.io).
|
||||||
Then, using a single command, you create and start all the services
|
A Compose file is used to define how the one or more containers that make up
|
||||||
from your configuration. To learn more about all the features of Compose
|
your application are configured.
|
||||||
see [the list of features](https://github.com/docker/docker.github.io/blob/master/compose/index.md#features).
|
Once you have a Compose file, you can create and start your application with a
|
||||||
|
single command: `docker-compose up`.
|
||||||
|
|
||||||
Compose is great for development, testing, and staging environments, as well as
|
Compose files can be used to deploy applications locally, or to the cloud on
|
||||||
CI workflows. You can learn more about each case in
|
[Amazon ECS](https://aws.amazon.com/ecs) or
|
||||||
[Common Use Cases](https://github.com/docker/docker.github.io/blob/master/compose/index.md#common-use-cases).
|
[Microsoft ACI](https://azure.microsoft.com/services/container-instances/) using
|
||||||
|
the Docker CLI. You can read more about how to do this:
|
||||||
|
- [Compose for Amazon ECS](https://docs.docker.com/engine/context/ecs-integration/)
|
||||||
|
- [Compose for Microsoft ACI](https://docs.docker.com/engine/context/aci-integration/)
|
||||||
|
|
||||||
Using Compose is basically a three-step process.
|
Where to get Docker Compose
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
### Windows and macOS
|
||||||
|
|
||||||
|
Docker Compose is included in
|
||||||
|
[Docker Desktop](https://www.docker.com/products/docker-desktop)
|
||||||
|
for Windows and macOS.
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
You can download Docker Compose binaries from the
|
||||||
|
[release page](https://github.com/docker/compose/releases) on this repository.
|
||||||
|
|
||||||
|
### Using pip
|
||||||
|
|
||||||
|
If your platform is not supported, you can download Docker Compose using `pip`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
pip install docker-compose
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note:** Docker Compose requires Python 3.6 or later.
|
||||||
|
|
||||||
|
Quick Start
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Using Docker Compose is basically a three-step process:
|
||||||
1. Define your app's environment with a `Dockerfile` so it can be
|
1. Define your app's environment with a `Dockerfile` so it can be
|
||||||
reproduced anywhere.
|
reproduced anywhere.
|
||||||
2. Define the services that make up your app in `docker-compose.yml` so
|
2. Define the services that make up your app in `docker-compose.yml` so
|
||||||
they can be run together in an isolated environment.
|
they can be run together in an isolated environment.
|
||||||
3. Lastly, run `docker-compose up` and Compose will start and run your entire app.
|
3. Lastly, run `docker-compose up` and Compose will start and run your entire
|
||||||
|
app.
|
||||||
|
|
||||||
A `docker-compose.yml` looks like this:
|
A Compose file looks like this:
|
||||||
|
|
||||||
version: '2'
|
```yaml
|
||||||
|
services:
|
||||||
|
web:
|
||||||
|
build: .
|
||||||
|
ports:
|
||||||
|
- "5000:5000"
|
||||||
|
volumes:
|
||||||
|
- .:/code
|
||||||
|
redis:
|
||||||
|
image: redis
|
||||||
|
```
|
||||||
|
|
||||||
services:
|
You can find examples of Compose applications in our
|
||||||
web:
|
[Awesome Compose repository](https://github.com/docker/awesome-compose).
|
||||||
build: .
|
|
||||||
ports:
|
|
||||||
- "5000:5000"
|
|
||||||
volumes:
|
|
||||||
- .:/code
|
|
||||||
redis:
|
|
||||||
image: redis
|
|
||||||
|
|
||||||
For more information about the Compose file, see the
|
For more information about the Compose format, see the
|
||||||
[Compose file reference](https://github.com/docker/docker.github.io/blob/master/compose/compose-file/compose-versioning.md).
|
[Compose file reference](https://docs.docker.com/compose/compose-file/).
|
||||||
|
|
||||||
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](https://docs.docker.com/compose/).
|
|
||||||
- Code repository for Compose is on [GitHub](https://github.com/docker/compose).
|
|
||||||
- If you find any problems please fill out an [issue](https://github.com/docker/compose/issues/new/choose). Thank you!
|
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
------------
|
------------
|
||||||
|
|
||||||
[](https://ci-next.docker.com/public/job/compose/job/master/)
|
Want to help develop Docker Compose? Check out our
|
||||||
|
[contributing documentation](https://github.com/docker/compose/blob/master/CONTRIBUTING.md).
|
||||||
|
|
||||||
Want to help build Compose? Check out our [contributing documentation](https://github.com/docker/compose/blob/master/CONTRIBUTING.md).
|
If you find an issue, please report it on the
|
||||||
|
[issue tracker](https://github.com/docker/compose/issues/new/choose).
|
||||||
|
|
||||||
Releasing
|
Releasing
|
||||||
---------
|
---------
|
||||||
|
Loading…
x
Reference in New Issue
Block a user