Docker Compose
==============
[![Build Status](https://ci-next.docker.com/public/buildStatus/icon?job=compose/master)](https://ci-next.docker.com/public/job/compose/job/master/)
![Docker Compose](logo.png?raw=true "Docker Compose Logo")
Docker Compose is a tool for running multi-container applications on Docker
defined using the [Compose file format](https://compose-spec.io).
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](https://aws.amazon.com/ecs) or
[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/)
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
reproduced anywhere.
2. Define the services that make up your app in `docker-compose.yml` so
they can be run together in an isolated environment.
3. Lastly, run `docker-compose up` and Compose will start and run your entire
app.
A Compose file looks like this:
```yaml
services:
web:
build: .
ports:
- "5000:5000"
volumes:
- .:/code
redis:
image: redis
```
You can find examples of Compose applications in our
[Awesome Compose repository](https://github.com/docker/awesome-compose).
For more information about the Compose format, see the
[Compose file reference](https://docs.docker.com/compose/compose-file/).
Contributing
------------
Want to help develop Docker 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
---------
Releases are built by maintainers, following an outline of the [release process](https://github.com/docker/compose/blob/master/project/RELEASE-PROCESS.md).
Raw data
{
"_id": null,
"home_page": "https://www.docker.com/",
"name": "docker-compose",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": "",
"keywords": "",
"author": "Docker, Inc.",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/1f/6a/f4703077123ad0c90026985cb9780c0703922c2a5451ab93fb63511d915a/docker-compose-1.29.2.tar.gz",
"platform": "",
"description": "Docker Compose\n==============\n[![Build Status](https://ci-next.docker.com/public/buildStatus/icon?job=compose/master)](https://ci-next.docker.com/public/job/compose/job/master/)\n\n![Docker Compose](logo.png?raw=true \"Docker Compose Logo\")\n\nDocker Compose is a tool for running multi-container applications on Docker\ndefined using the [Compose file format](https://compose-spec.io).\nA Compose file is used to define how the one or more containers that make up\nyour application are configured.\nOnce you have a Compose file, you can create and start your application with a\nsingle command: `docker-compose up`.\n\nCompose files can be used to deploy applications locally, or to the cloud on\n[Amazon ECS](https://aws.amazon.com/ecs) or\n[Microsoft ACI](https://azure.microsoft.com/services/container-instances/) using\nthe Docker CLI. You can read more about how to do this:\n- [Compose for Amazon ECS](https://docs.docker.com/engine/context/ecs-integration/)\n- [Compose for Microsoft ACI](https://docs.docker.com/engine/context/aci-integration/)\n\nWhere to get Docker Compose\n----------------------------\n\n### Windows and macOS\n\nDocker Compose is included in\n[Docker Desktop](https://www.docker.com/products/docker-desktop)\nfor Windows and macOS.\n\n### Linux\n\nYou can download Docker Compose binaries from the\n[release page](https://github.com/docker/compose/releases) on this repository.\n\n### Using pip\n\nIf your platform is not supported, you can download Docker Compose using `pip`:\n\n```console\npip install docker-compose\n```\n\n> **Note:** Docker Compose requires Python 3.6 or later.\n\nQuick Start\n-----------\n\nUsing Docker Compose is basically a three-step process:\n1. Define your app's environment with a `Dockerfile` so it can be\n reproduced anywhere.\n2. Define the services that make up your app in `docker-compose.yml` so\n they can be run together in an isolated environment.\n3. Lastly, run `docker-compose up` and Compose will start and run your entire\n app.\n\nA Compose file looks like this:\n\n```yaml\nservices:\n web:\n build: .\n ports:\n - \"5000:5000\"\n volumes:\n - .:/code\n redis:\n image: redis\n```\n\nYou can find examples of Compose applications in our\n[Awesome Compose repository](https://github.com/docker/awesome-compose).\n\nFor more information about the Compose format, see the\n[Compose file reference](https://docs.docker.com/compose/compose-file/).\n\nContributing\n------------\n\nWant to help develop Docker Compose? Check out our\n[contributing documentation](https://github.com/docker/compose/blob/master/CONTRIBUTING.md).\n\nIf you find an issue, please report it on the\n[issue tracker](https://github.com/docker/compose/issues/new/choose).\n\nReleasing\n---------\n\nReleases are built by maintainers, following an outline of the [release process](https://github.com/docker/compose/blob/master/project/RELEASE-PROCESS.md).\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Multi-container orchestration for Docker",
"version": "1.29.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "25bd3a0cf152cd5024f33b45fb745950",
"sha256": "8d5589373b35c8d3b1c8c1182c6e4a4ff14bffa3dd0b605fcd08f73c94cef809"
},
"downloads": -1,
"filename": "docker_compose-1.29.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "25bd3a0cf152cd5024f33b45fb745950",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.4",
"size": 114764,
"upload_time": "2021-05-10T11:22:10",
"upload_time_iso_8601": "2021-05-10T11:22:10.021899Z",
"url": "https://files.pythonhosted.org/packages/f3/3e/ca05e486d44e38eb495ca60b8ca526b192071717387346ed1031ecf78966/docker_compose-1.29.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "95accbca655abf086a61b94d6c3d94ca",
"sha256": "4c8cd9d21d237412793d18bd33110049ee9af8dab3fe2c213bbd0733959b09b7"
},
"downloads": -1,
"filename": "docker-compose-1.29.2.tar.gz",
"has_sig": false,
"md5_digest": "95accbca655abf086a61b94d6c3d94ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 288627,
"upload_time": "2021-05-10T11:22:11",
"upload_time_iso_8601": "2021-05-10T11:22:11.785931Z",
"url": "https://files.pythonhosted.org/packages/1f/6a/f4703077123ad0c90026985cb9780c0703922c2a5451ab93fb63511d915a/docker-compose-1.29.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-05-10 11:22:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "docker-compose"
}