Skip to content

Commit 85d70ff

Browse files
londoncallinglondoncalling
authored
clarify Compose install prerequisites (docker#4130)
* clarify Compose install prerequisites Signed-off-by: Victoria Bialas <victoria.bialas@docker.com> * organized install on Microsoft Server into steps Signed-off-by: Victoria Bialas <victoria.bialas@docker.com> * better highlighting and organization for the desktop systems section Signed-off-by: Victoria Bialas <victoria.bialas@docker.com> * copyedit for consistency Signed-off-by: Victoria Bialas <victoria.bialas@docker.com> * changed Docker server --> Docker per review Signed-off-by: Victoria Bialas <victoria.bialas@docker.com> * attempt to clarify Compose / Docker Engine dependencies per reviews Signed-off-by: Victoria Bialas <victoria.bialas@docker.com> * copyedits per reviews Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
1 parent 37ece96 commit 85d70ff

File tree

1 file changed

+52
-32
lines changed

1 file changed

+52
-32
lines changed

‎compose/install.md‎

Lines changed: 52 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,53 @@ keywords: compose, orchestration, install, installation, docker, documentation
44
title: Install Docker Compose
55
---
66

7-
You can run Compose on macOS, Windows and 64-bit Linux. To install it, you'll need to install Docker first.
7+
You can run Compose on macOS, Windows and 64-bit Linux.
88

9-
To install Compose, do the following:
9+
## Prerequisites
1010

11-
1. Install Docker Engine:
11+
Docker Compose relies on Docker Engine for any meaningful work, so make sure you
12+
have Docker Engine installed either locally or remote, depending on your setup.
1213

13-
* [Mac installation](/docker-for-mac/index.md){: target="_blank" class="_"}
14+
- On desktop systems like Docker for Mac and Windows, Docker Compose is
15+
included as part of those desktop installs. Skip down to [Install Compose on Mac or Windows systems](#install-compose-on-mac-or-windows-systems).
1416

15-
* [Windows installation](/docker-for-windows/index.md){: target="_blank" class="_"}
17+
- On Linux systems, first install the
18+
[Docker](/engine/installation/index.md#server){: target="_blank" class="_"}
19+
for your OS as described on the Get Docker page, then come back here for
20+
instructions on installing [installing Compose on
21+
Linux](#install-compose-on-linux-systems).
1622

17-
* [Ubuntu installation](/engine/installation/linux/ubuntu.md){: target="_blank" class="_"}
23+
## Install Compose on Mac or Windows systems
1824

19-
* [Other systems](/engine/installation/index.md){: target="_blank" class="_"}
25+
**Docker for Mac**, **Docker for Windows**, and **Docker Toolbox**
26+
already include Compose along with other Docker apps, so most Mac
27+
and Windows users do not need to install Compose separately.
28+
Docker install instructions for these are here:
2029

21-
2. **[Docker for Mac](/docker-for-mac/install.md)**, **[Docker for Windows](/docker-for-windows/install.md)**, and **[Docker Toolbox](/toolbox/overview.md)** include Docker Compose, so most Mac and Windows users do not need to install Docker Compose separately.
30+
* [Get Docker for Mac](/docker-for-mac/install.md)
31+
* [Get Docker for Windows](/docker-for-windows/install.md)
32+
* [Get Docker Toolbox](/toolbox/overview.md) (for older systems)
2233

23-
If you are running the Docker daemon and client directly on
24-
**Microsoft Windows Server 2016** (with [Docker EE for Windows Server 2016](/engine/installation/windows/docker-ee.md), you _do_ need to install Docker Compose.
34+
**If you are running the Docker daemon and client directly on Microsoft
35+
Windows Server 2016** (with [Docker EE for Windows Server 2016](/engine/installation/windows/docker-ee.md), you _do_ need to install
36+
Docker Compose. To do so, follow these steps:
2537

26-
To do this, start an "elevated" PowerShell (run it as administrator). Search
27-
for PowerShell, right-click, and choose **Run as administrator**. When asked
28-
if you want to allow this app to make changes to your device, click **Yes**.
38+
1. Start an "elevated" PowerShell (run it as administrator).
2939

30-
Run the following command to download Docker Compose, replacing
31-
`$dockerComposeVersion` with the specific version of Compose you want to use:
40+
Search for PowerShell, right-click, and choose
41+
**Run as administrator**. When asked if you want to allow this app
42+
to make changes to your device, click **Yes**.
43+
44+
In PowerShell, run the following command to download
45+
Docker Compose, replacing `$dockerComposeVersion` with the specific
46+
version of Compose you want to use:
3247

3348
```none
3449
Invoke-WebRequest "https://github.com/docker/compose/releases/download/$dockerComposeVersion/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\docker\docker-compose.exe
3550
```
3651
37-
For example, to download Compose version {{ site.compose_current }}, the command is:
52+
For example, to download Compose version {{ site.compose_current }},
53+
the command is:
3854
3955
```none
4056
Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{site.compose_current}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\docker\docker-compose.exe
@@ -50,32 +66,36 @@ To install Compose, do the following:
5066
on the [Compose repository release page on GitHub](https://github.com/docker/compose/releases){:target="_blank" class="_"}.
5167
{: .important}
5268
53-
Now, run the executable to install Compose.
69+
3. Run the executable to install Compose.
5470
55-
3. On **Linux**, you can download the Docker Compose binary from the
56-
[Compose repository release page on GitHub](https://github.com/docker/compose/releases){: target="_blank" class="_"}.
57-
Follow the instructions from the link, which involve running the `curl` command in your terminal to download the binaries.
58-
59-
> Got a "Permission denied" error?
60-
>
61-
If so, your `/usr/local/bin` directory probably isn't writable and
62-
you'll need to install Compose as the superuser. Run `sudo -i`, then
63-
run the download and install commands below, then `exit`.
71+
## Install Compose on Linux systems
6472
73+
On **Linux**, you can download the Docker Compose binary from the [Compose
74+
repository release page on GitHub](https://github.com/docker/compose/releases){:
75+
target="_blank" class="_"}. Follow the instructions from the link, which involve
76+
running the `curl` command in your terminal to download the binaries. These step
77+
by step instructions are also included below.
6578
66-
Run this command to download Docker Compose, replacing
79+
1. Run this command to download Docker Compose, replacing
6780
`$dockerComposeVersion` with the specific version of Compose you want to use:
6881
6982
```bash
7083
curl -L https://github.com/docker/compose/releases/download/$dockerComposeVersion/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
7184
```
7285
73-
For example, to download Compose version {{site.compose_current}}, the command is:
86+
For example, to download Compose version {{site.compose_current}}, the command
87+
is:
7488
7589
```bash
7690
curl -L https://github.com/docker/compose/releases/download/{{site.compose_current}}/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
7791
```
7892
93+
> Got a "Permission denied" error?
94+
>
95+
If so, your `/usr/local/bin` directory probably isn't writable and
96+
you'll need to install Compose as the superuser. Run `sudo -i`, then
97+
run the download and install commands below, then `exit`.
98+
7999
> Use the latest Compose release number in the download command.
80100
>
81101
The above command is an _example_, and it may become out-of-date once
@@ -84,22 +104,22 @@ To install Compose, do the following:
84104
if needed, replace `$dockerComposeVersion` with the release number that
85105
you want. Compose releases are also available for direct download on
86106
the [Compose repository release page on GitHub](https://github.com/docker/compose/releases){: target="_blank"
87-
class="_"}.
107+
class="_"}.
88108
{: .important}
89109
90110
If you have problems installing with `curl`, see
91111
[Alternative Install Options](install.md#alternative-install-options).
92112
93-
5. Apply executable permissions to the binary:
113+
2. Apply executable permissions to the binary:
94114
95115
```bash
96116
sudo chmod +x /usr/local/bin/docker-compose
97117
```
98118
99-
6. Optionally, install [command completion](completion.md) for the
119+
3. Optionally, install [command completion](completion.md) for the
100120
`bash` and `zsh` shell.
101121
102-
7. Test the installation.
122+
4. Test the installation.
103123
104124
```bash
105125
$ docker-compose --version

0 commit comments

Comments
 (0)