Skip to content

ENGDOCS-2589 #22507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 28, 2025
+25 −45
Merged

ENGDOCS-2589 #22507

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d36720
ENGDOCS-2589
aevesdocker Apr 28, 2025
ad032ca
ENGDOCS-2589
aevesdocker Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/manuals/compose/bridge/_index.md
View file
Original file line number Diff line number Diff line change
@@ -32,6 +32,7 @@ To get started with Compose Bridge, you need to:
2. Sign in to your Docker account.
3. Navigate to the **Features in development** tab in **Settings**.
4. From the **Experimental features** tab, select **Enable Compose Bridge**.
5. Select **Apply & restart**.

## Feedback

32 changes: 11 additions & 21 deletions content/manuals/compose/install/_index.md
View file
Original file line number Diff line number Diff line change
@@ -14,46 +14,36 @@
- /compose/install/compose-desktop/
---

This page contains summary information about the available options for installing Docker Compose.
This page summarizes the different ways you can install Docker Compose, depending on your platform and needs.

## Installation scenarios

### Scenario one: Install Docker Desktop
### Scenario one: Install Docker Desktop (Recommended)

The easiest and recommended way to get Docker Compose is to install Docker Desktop. Docker Desktop
includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
The easiest and recommended way to get Docker Compose is to install Docker Desktop.

Docker Desktop is available on:
Docker Desktop includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.

Docker Desktop is available for:
- [Linux](/manuals/desktop/setup/install/linux/_index.md)
- [Mac](/manuals/desktop/setup/install/mac-install.md)
- [Windows](/manuals/desktop/setup/install/windows-install.md)

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 {{< inline-image src="../../desktop/images/whale-x.svg" alt="whale menu" >}}.

> [!NOTE]
>
> After Docker Compose V1 was removed in Docker Desktop version [4.23.0](/desktop/release-notes/#4230) as it had reached end-of-life,
> the `docker-compose` command now points directly to the Docker Compose V2 binary, running in standalone mode.
> If you rely on Docker Desktop auto-update, the symlink might be broken and command unavailable, as the update doesn't ask for administrator password.
> [!TIP]
>
> This only affects Mac users. To fix this, either recreate the symlink:
> ```console
> $ sudo rm /usr/local/bin/docker-compose
> $ sudo ln -s /Applications/Docker.app/Contents/Resources/cli-plugins/docker-compose /usr/local/bin/docker-compose
> ```
> Or enable [Automatically check configuration](/manuals/desktop/settings-and-maintenance/settings.md) which will detect and fix it for you.
> 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 {{< inline-image src="../../desktop/images/whale-x.svg" alt="whale menu" >}}.

### Scenario two: Install the Docker Compose plugin
### Scenario two: Install the Docker Compose plugin (Linux only)

Check warning on line 36 in content/manuals/compose/install/_index.md

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.HeadingLength] Try to keep headings short (< 8 words).

Raw Output:
{"message": "[Docker.HeadingLength] Try to keep headings short (\u003c 8 words).", "location": {"path": "content/manuals/compose/install/_index.md", "range": {"start": {"line": 36, "column": 5}}}, "severity": "INFO"}

> [!IMPORTANT]
>
> This install scenario is only available on Linux.
> This method is only available on Linux.

If you already have Docker Engine and Docker CLI installed, you can install the Docker Compose plugin from the command line, by either:
- [Using Docker's repository](linux.md#install-using-the-repository)
- [Downloading and installing manually](linux.md#install-the-plugin-manually)

### Scenario three: Install the Docker Compose standalone
### Scenario three: Install the Docker Compose standalone (Legacy)

> [!WARNING]
>
19 changes: 3 additions & 16 deletions content/manuals/compose/install/linux.md
View file
Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ To install the Docker Compose plugin on Linux, you can either:

> [!NOTE]
>
> These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Docker Compose plugin. For the Docker Compose standalone, see [Install the Docker Compose Standalone](standalone.md).
> These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Docker Compose plugin.

## Install using the repository

@@ -58,14 +58,6 @@ To install the Docker Compose plugin on Linux, you can either:
$ docker compose version
```

Expected output:

```text
Docker Compose version vN.N.N
```

Where `vN.N.N` is placeholder text standing in for the latest version.

### Update Docker Compose

To update the Docker Compose plugin, run the following commands:
@@ -85,7 +77,7 @@ To update the Docker Compose plugin, run the following commands:

## Install the plugin manually

> [!NOTE]
> [!IMPORTANT]
>
> This option requires you to manage upgrades manually. It is recommended that you set up Docker's repository for easier maintenance.

@@ -121,9 +113,4 @@ To update the Docker Compose plugin, run the following commands:
```console
$ docker compose version
```

Expected output:

```text
Docker Compose version {{% param "compose_version" %}}
```

18 changes: 10 additions & 8 deletions content/manuals/compose/install/uninstall.md
View file
Original file line number Diff line number Diff line change
@@ -4,43 +4,45 @@
title: Uninstall Docker Compose
---

Uninstalling Docker Compose depends on the method you have used to install Docker Compose. On this page you can find specific instructions to uninstall Docker Compose.
How you uninstall Docker Compose depends on how it was installed. This guide covers uninstallation instructions for:

Check failure on line 7 in content/manuals/compose/install/uninstall.md

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'uninstallation'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'uninstallation'?", "location": {"path": "content/manuals/compose/install/uninstall.md", "range": {"start": {"line": 7, "column": 85}}}, "severity": "ERROR"}

- Docker Compose installed via Docker Desktop
- Docker Compose installed as a CLI plugin

## Uninstalling Docker Desktop
## Uninstalling Docker Compose with Docker Desktop

If you want to uninstall Docker Compose and you have installed Docker Desktop, see [Uninstall Docker Desktop](/manuals/desktop/uninstall.md).

> [!NOTE]
>
> Unless you have other Docker instances installed on that specific environment, you would be removing Docker altogether by uninstalling Docker Desktop.
> Unless you have other Docker instances installed on that specific environment, uninstalling Docker Desktop removes all Docker components, including Docker Engine, Docker CLI, and Docker Compose.

## Uninstalling the Docker Compose CLI plugin

To remove the Docker Compose CLI plugin, run:
If you installed Docker Compose via a package manager, run:

Ubuntu, Debian:
On Ubuntu or Debian:

```console
$ sudo apt-get remove docker-compose-plugin
```
RPM-based distributions:
On RPM-based distributions:

```console
$ sudo yum remove docker-compose-plugin
```

### Manually installed

If you used `curl` to install Docker Compose CLI plugin, to uninstall it, run:
If you installed Docker Compose manually (using curl), remove it by deleting the binary:

```console
$ rm $DOCKER_CONFIG/cli-plugins/docker-compose
```

### Remove for all users

Or, if you have installed Docker Compose for all users, run:
If installed for all users, remove it from the system directory:

```console
$ rm /usr/local/lib/docker/cli-plugins/docker-compose