Skip to content

Commit f5a7485

Browse files
authored
ENGDOCS-1020 (docker#15857)
* ENGDOCS-1020 * fix broken links * fix build * add important note
1 parent 3a191bf commit f5a7485

File tree

4 files changed

+48
-72
lines changed

4 files changed

+48
-72
lines changed

_data/toc.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1558,13 +1558,13 @@ manuals:
15581558
- sectiontitle: Install Docker Compose
15591559
section:
15601560
- path: /compose/install/
1561-
title: Install overview
1561+
title: Overview
15621562
- path: /compose/install/linux/
1563-
title: Install on Linux
1563+
title: Install the Compose plugin
15641564
- path: /compose/install/other/
1565-
title: Other install scenarios
1565+
title: Install the Compose standalone
15661566
- path: /compose/install/uninstall/
1567-
title: Uninstall Docker Compose
1567+
title: Uninstall Compose
15681568
- path: /compose/gettingstarted/
15691569
title: Try Docker Compose
15701570
- sectiontitle: Compose V2

compose/install/index.md

Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,44 @@
11
---
22
description: How to install Docker Compose
33
keywords: compose, orchestration, install, installation, docker, documentation
4-
title: Install Docker Compose
4+
title: Overview
55
toc_max: 3
66
redirect_from:
77
- /compose/compose-desktop/
88
---
99

10-
On this page you can find information on how to get and install Compose.
10+
This page contains summary information about the available options for getting Docker Compose.
1111

12-
## Install Compose
12+
## Installation scenarios
1313

14-
If you have Docker Desktop, you've got a full Docker installation, including Compose.
14+
### Scenario one: Install Docker Desktop
1515

16-
You can check this by clicking on **About Docker Desktop** from the Docker menu ![whale menu](../../desktop/images/whale-x.svg){: .inline}.
16+
The easiest and recommended way to get Docker Compose is to install Docker Desktop. Docker Desktop
17+
includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
1718

18-
![about-desktop](../../desktop/images/about_desktop_versions.png){:width="750px"}
19+
Docker Desktop is available on:
20+
- [Linux](../../desktop/install/linux-install.md)
21+
- [Mac](../../desktop/install/mac-install.md)
22+
- [Windows](../../desktop/install/windows-install.md)
1923

20-
### New Docker Installation
24+
If you have already installed Docker Desktop, you can check which version of Compose you have by selecting **About Docker Desktop** from the Docker menu ![whale menu](../../desktop/images/whale-x.svg){: .inline}
2125

22-
If you haven’t yet installed Docker Desktop:
26+
### Scenario two: Install the Compose plugin
2327

24-
{% assign yes = '![yes](/assets/images/green-check.svg){: .inline style="height: 14px; margin: 0 auto; align=right"}' %}
28+
If you already have Docker Engine and Docker CLI installed, you can install the Compose plugin from the command line, by either:
29+
- [Using Docker's repository](linux.md#install-using-the-repository)
30+
- [Downloading and installing manually](linux.md#install-the-plugin-manually)
2531

26-
| Platform | Docker Desktop |
27-
|:---------------|:------------------------------:|
28-
|Linux (64-bit) |{{ yes }} [Install](../../desktop/install/linux-install.md)|
29-
|Mac |{{ yes }} [Install](../../desktop/install/mac-install.md)|
30-
|Windows |{{ yes }} [Install](../../desktop/install/windows-install.md)|
32+
>Note
33+
>
34+
>This is only available on Linux
35+
{: .important}
3136

37+
### Scenario three: Install the Compose standalone
3238

33-
### Pre-existing Docker Installation
39+
You can [install the Compose standalone](other.md) on Linux or on Windows Server.
3440

35-
If you have a Docker installation on Linux to which you want to add the Compose plugin, you can choose one of these options:
36-
37-
* [Install using the repository](./linux.md#install-using-the-repository)
38-
* [Install the plugin manually](./linux.md#install-the-plugin-manually)
39-
40-
### Other install scenarios
41-
42-
For other options, see [Other install scenarios](./other.md).
43-
44-
45-
## Where to go next
46-
47-
- [Getting Started](../gettingstarted.md)
48-
- [Command line reference](../../reference/index.md)
49-
- [Compose file reference](../compose-file/index.md)
50-
- [Sample apps with Compose](../samples-for-compose.md)
51-
52-
## Feedback
53-
54-
We'd love to hear from you about the improvements we've recently made to the Docker Compose installation instructions. Let us know what you think by completing this short [survey](https://survey.alchemer.com/s3/7002962/Compose-Install-Documentation-Feedback){:target="_blank" rel="noopener" class="_"}.
41+
>Note
42+
>
43+
>This install scenario is no longer supported.
44+
{: .important}

compose/install/linux.md

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,24 @@
22
description: How to install Docker Compose on Linux
33
keywords: compose, orchestration, install, installation, docker, documentation
44
toc_max: 3
5-
6-
title: Install on Linux
5+
title: Install the Compose plugin
76
redirect_from:
87
- /compose/compose-plugin/
98
- /compose/compose-linux/
10-
119
---
1210

13-
On this page you can find instructions on how to install the Compose on Linux from the command line.
14-
15-
## Install Compose
16-
17-
To install Compose:
18-
* Option 1: [Set up Docker's repository on your Linux system](#install-using-the-repository).
19-
* Option 2: [Install Compose manually](#install-the-plugin-manually).
11+
On this page you can find instructions on how to install the Compose plugin on Linux from the command line.
2012

21-
### Install using the repository
13+
To install the Compose plugin on Linux, you can either:
14+
- [Set up Docker's repository on your Linux system](#install-using-the-repository).
15+
- [Install Compose manually](#install-the-plugin-manually).
2216

2317
> **Note**
2418
>
2519
> These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin.
26-
For Compose standalone, see [Install Compose Standalone](other.md#install-compose-standalone).
20+
For Compose standalone, see [Install Compose Standalone](other.md).
2721

28-
If you have already set up the Docker repository, jump to step 2.
22+
### Install using the repository
2923

3024
1. Set up the repository. Find distro-specific instructions in:
3125

@@ -36,15 +30,15 @@ If you have already set up the Docker repository, jump to step 2.
3630
[RHEL](../../engine/install/rhel.md/#set-up-the-repository) |
3731
[SLES](../../engine/install/sles.md/#set-up-the-repository).
3832

39-
2. Update the package index, and install the _latest version_ of Docker Compose:
33+
2. Update the package index, and install the latest version of Docker Compose:
4034

41-
* Ubuntu, Debian:
35+
* For Ubuntu and Debian, run:
4236

4337
```console
4438
$ sudo apt-get update
4539
$ sudo apt-get install docker-compose-plugin
4640
```
47-
* RPM-based distros:
41+
* For RPM-based distros, run:
4842

4943
```console
5044
$ sudo yum update
@@ -62,15 +56,15 @@ Where `vN.N.N` is placeholder text standing in for the latest version.
6256

6357
#### Update Compose
6458

65-
To update Compose, run the following commands:
59+
To update the Compose plugin, run the following commands:
6660

67-
* Ubuntu, Debian:
61+
* For Ubuntu and Debian, run:
6862

6963
```console
7064
$ sudo apt-get update
7165
$ sudo apt-get install docker-compose-plugin
7266
```
73-
* RPM-based distros:
67+
* For RPM-based distros, run:
7468

7569
```console
7670
$ sudo yum update
@@ -81,7 +75,7 @@ To update Compose, run the following commands:
8175

8276
> **Note**
8377
>
84-
> This option requires you to manage upgrades manually. We recommend setting up Docker's repository for an easier maintenance.
78+
> This option requires you to manage upgrades manually. We recommend setting up Docker's repository for easier maintenance.
8579

8680
1. To download and install the Compose CLI plugin, run:
8781

@@ -115,10 +109,3 @@ To update Compose, run the following commands:
115109
$ docker compose version
116110
Docker Compose version {{site.compose_version}}
117111
```
118-
119-
## Where to go next
120-
121-
- [Manage Docker as a non-root user](../../engine/install/linux-postinstall.md)
122-
- [Command line reference](../../reference/index.md)
123-
- [Compose file reference](../compose-file/index.md)
124-
- [Sample apps with Compose](../samples-for-compose.md)

compose/install/other.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,16 @@
22
description: How to install Docker Compose - Other Scenarios
33
keywords: compose, orchestration, install, installation, docker, documentation
44
toc_max: 3
5-
6-
title: Other install Scenarios
5+
title: Install the Compose standalone
76
---
87

9-
## Install Compose Standalone
8+
On this page you can find instructions on how to install the Compose standalone on Linux or Windows Server, from the command line.
109

1110
### On Linux
1211
> **Compose standalone**
1312
>
14-
> Note that Compose standalone uses the _dash compose_ syntax instead of current's standard syntax (_space compose_).
15-
For example: type `docker-compose up` when using Compose standalone, instead of `docker compose up`.
13+
> Note that Compose standalone uses the `-compose` syntax instead of the current standard syntax `compose`.
14+
>For example type `docker-compose up` when using Compose standalone, instead of `docker compose up`.
1615
1716
1. To download and install Compose standalone, run:
1817
```console
@@ -35,7 +34,7 @@ For example: type `docker-compose up` when using Compose standalone, instead of
3534
Follow these instructions if you are running the Docker daemon and client directly
3635
on Microsoft Windows Server and want to install Docker Compose.
3736
38-
1. Run a PowerShell as an administrator.
37+
1. Run PowerShell as an administrator.
3938
When asked if you want to allow this app to make changes to your device, click **Yes** in order to proceed with the installation.
4039
4140
2. GitHub now requires TLS1.2. In PowerShell, run the following:

0 commit comments

Comments
 (0)