README.md
1Docker Compose
2==============
3
4
5Compose is a tool for defining and running multi-container Docker applications.
6With Compose, you use a Compose file to configure your application's services.
7Then, using a single command, you create and start all the services
8from your configuration. To learn more about all the features of Compose
9see [the list of features](https://github.com/docker/docker.github.io/blob/master/compose/overview.md#features).
10
11Compose is great for development, testing, and staging environments, as well as
12CI workflows. You can learn more about each case in
13[Common Use Cases](https://github.com/docker/docker.github.io/blob/master/compose/overview.md#common-use-cases).
14
15Using Compose is basically a three-step process.
16
171. Define your app's environment with a `Dockerfile` so it can be
18reproduced anywhere.
192. Define the services that make up your app in `docker-compose.yml` so
20they can be run together in an isolated environment.
213. Lastly, run `docker-compose up` and Compose will start and run your entire app.
22
23A `docker-compose.yml` looks like this:
24
25 version: '2'
26
27 services:
28 web:
29 build: .
30 ports:
31 - "5000:5000"
32 volumes:
33 - .:/code
34 redis:
35 image: redis
36
37For more information about the Compose file, see the
38[Compose file reference](https://github.com/docker/docker.github.io/blob/master/compose/compose-file/compose-versioning.md).
39
40Compose has commands for managing the whole lifecycle of your application:
41
42 * Start, stop and rebuild services
43 * View the status of running services
44 * Stream the log output of running services
45 * Run a one-off command on a service
46
47Installation and documentation
48------------------------------
49
50- Full documentation is available on [Docker's website](https://docs.docker.com/compose/).
51- Code repository for Compose is on [GitHub](https://github.com/docker/compose).
52- If you find any problems please fill out an [issue](https://github.com/docker/compose/issues/new/choose). Thank you!
53
54Contributing
55------------
56
57[](https://jenkins.dockerproject.org/job/docker/job/compose/job/master/)
58
59Want to help build Compose? Check out our [contributing documentation](https://github.com/docker/compose/blob/master/CONTRIBUTING.md).
60
61Releasing
62---------
63
64Releases are built by maintainers, following an outline of the [release process](https://github.com/docker/compose/blob/master/project/RELEASE-PROCESS.md).
65
