mirror of https://github.com/docker/docs.git
ENGDOCS-744 Compose Install Fixes (#14892)
* Review feedback edits * Compose version update * Style and other minor fixes
This commit is contained in:
Dora Ribeiro
GitHub
parent
0da65dd61d
commit
0dd93e250e
|
|
@ -40,7 +40,7 @@ exclude:
|
|||
latest_engine_api_version: "1.41"
|
||||
docker_ce_version: "20.10"
|
||||
compose_v1_version: "1.29.2"
|
||||
compose_version: "v2.5.0"
|
||||
compose_version: "v2.6.0"
|
||||
compose_file_v3: "3.9"
|
||||
compose_file_v2: "2.4"
|
||||
machine_version: "0.16.0"
|
||||
|
|
|
|||
|
|
@ -1400,12 +1400,6 @@ manuals:
|
|||
title: Docker Scan
|
||||
- path: /engine/sbom/
|
||||
title: Docker SBOM (Experimental)
|
||||
|
||||
- sectiontitle: Docker Build
|
||||
section:
|
||||
- path: /build/
|
||||
title: Overview
|
||||
|
||||
- sectiontitle: Docker Compose
|
||||
section:
|
||||
- path: /compose/
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ title: Install Compose through Docker Desktop
|
|||
With Docker Desktop you get Docker Engine, Docker CLI with Compose plugin as well as other components and tools.
|
||||
Check a list of what's shipped with Docker Desktop and a list of key features in the [Docker Desktop Overview](../../desktop/index.md){:target="_blank" rel="noopener" class="_"} page.
|
||||
|
||||
Docker Desktop is available for Mac, Windows and Linux.
|
||||
Docker Desktop is available for Mac, Windows, and Linux.
|
||||
For download information, system requirements, and installation instructions, see:
|
||||
|
||||
* [Docker Desktop for Linux](../../desktop/linux/install.md){:target="_blank" rel="noopener" class="_"}
|
||||
|
|
|
|||
|
|
@ -6,22 +6,14 @@ toc_max: 3
|
|||
title: Install Docker Compose CLI plugin
|
||||
---
|
||||
|
||||
In this page you can find instructions on how to install Compose Plugin for Docker CLI in:
|
||||
* Linux
|
||||
* Windows Server
|
||||
|
||||
|
||||
## Compose Prerequisites
|
||||
|
||||
* Docker Compose requires Docker Engine.
|
||||
* Docker Compose plugin requires Docker CLI.
|
||||
|
||||
On this page you can find instructions on how to install the Compose plugin for Docker CLI on Linux and Windows Server operating systems.
|
||||
>Note that installing Docker Compose as a plugin requires Docker CLI.
|
||||
|
||||
## Installing Compose on Linux systems
|
||||
|
||||
In this section you can find various routes for installing Compose in Linux.
|
||||
In this section, you can find various methods for installing Compose on Linux.
|
||||
|
||||
### Installation Methods
|
||||
### Installation methods
|
||||
|
||||
* [Installing Docker Desktop for Linux](../../desktop/linux/install.md/){:target="_blank" rel="noopener" class="_"} is the easiest and recommended installation route.
|
||||
Check the Desktop for Linux [supported platforms](../../desktop/linux/install.md/#supported-platforms){:target="_blank" rel="noopener" class="_"} page to verify the supported Linux distributions and architectures.
|
||||
|
|
@ -31,12 +23,11 @@ The following other methods are possible:
|
|||
|
||||
* __Using the automated convenience scripts__ (for testing and development environments).
|
||||
These scripts install Docker Engine and Docker CLI with the Compose plugin.
|
||||
For this route, go to the [Docker Engine install](../../../engine/install/){:target="_blank" rel="noopener" class="_"}
|
||||
page and follow the provided instructions. _After Desktop for Linux this is the recommended route._
|
||||
For this route, go to the [Docker Engine install](../../../engine/install/){:target="_blank" rel="noopener" class="_"} page and follow the provided instructions. _After installing Desktop for Linux, this is the recommended route._
|
||||
|
||||
* __Setting up Docker's repository__ and using it to install Docker CLI Compose plugin. See the [Install using the repository](#install-using-the-repository) section in this page. _This is the second best route._
|
||||
* __Setting up Docker's repository__ and using it to install Docker CLI Compose plugin. See the [Install using the repository](#install-using-the-repository) section on this page. _This is the second best route._
|
||||
|
||||
* __Installing the Docker CLI Compose plugin binary manually__. See the [Install the plugin manually](#install-the-plugin-manually) section in this page. _Note that this option requires you to manage upgrades manually as well._
|
||||
* __Installing the Docker CLI Compose plugin manually__. See the [Install the plugin manually](#install-the-plugin-manually) section on this page. _Note that this option requires you to manage upgrades manually as well._
|
||||
|
||||
|
||||
### Install using the repository
|
||||
|
|
@ -51,11 +42,11 @@ For other Linux installation methods see [this summary](#installation-methods).
|
|||
|
||||
If you have already set up the Docker repository jump to step 2.
|
||||
|
||||
1. Set up the repository. Go to the "Set up the repository" section of the chosen [Linux distribution](../../engine/install/index.md#server){:target="_blank" rel="noopener" class="_"}. found in the Docker Engine installation pages to check the instructions.
|
||||
1. Set up the repository. Go to the "Set up the repository" section of the chosen [Linux distribution](../../engine/install/index.md#server){:target="_blank" rel="noopener" class="_"}. found on the Docker Engine installation pages to check the instructions.
|
||||
|
||||
2. Update the `apt` package index, and install the _latest version_ of Docker Compose:
|
||||
|
||||
> Or, if using a different distro, use the equivalent package manager instructions.
|
||||
> Or, if using a different distro, use the equivalent package manager instructions.
|
||||
|
||||
|
||||
```console
|
||||
|
|
@ -91,7 +82,7 @@ If you have already set up the Docker repository jump to step 2.
|
|||
Docker Compose version v2.3.3
|
||||
```
|
||||
|
||||
### Install the Plugin manually
|
||||
### Install the plugin manually
|
||||
|
||||
> **Note**
|
||||
>
|
||||
|
|
@ -110,10 +101,10 @@ If you have already set up the Docker repository jump to step 2.
|
|||
$ curl -SL https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
|
||||
```
|
||||
|
||||
This command downloads the latest release of Docker Compose (from the Compose releases repository) and installs Compose for _the active user_ under `$HOME` directory.
|
||||
This command downloads the latest release of Docker Compose (from the Compose releases repository) and installs Compose for the active user under `$HOME` directory.
|
||||
|
||||
> To install:
|
||||
>* Docker Compose for _all users_ on your system, replace `~/.docker/ cli-plugins` with `/usr/local/lib/docker/cli-plugins`.
|
||||
>* Docker Compose for _all users_ on your system, replace `~/.docker/cli-plugins` with `/usr/local/lib/docker/cli-plugins`.
|
||||
>* A different version of Compose, substitute `{{site.compose_version}}` with the version of Compose you want to use.
|
||||
|
||||
2. Apply executable permissions to the binary:
|
||||
|
|
|
|||
|
|
@ -5,34 +5,33 @@ title: Install Docker Compose
|
|||
toc_max: 2
|
||||
---
|
||||
|
||||
In this page you can find a summary of the available options for installing Compose.
|
||||
On this page you can find a summary of the available options for installing Docker Compose.
|
||||
|
||||
## Compose Prerequisites
|
||||
## Compose prerequisites
|
||||
|
||||
* Docker Compose requires Docker Engine.
|
||||
* Docker Compose plugin requires Docker CLI.
|
||||
|
||||
## Compose Installation Scenarios
|
||||
## Compose installation scenarios
|
||||
You can run Compose on macOS, Windows, and 64-bit Linux. Check what installation scenario fits your needs.
|
||||
|
||||
Are you looking to:
|
||||
|
||||
* __Get latest Compose and its prerequisites right of the bat__:
|
||||
[Install Docker Desktop for your platform](compose-desktop.md). This is the fastest route and you get Docker Engine and Docker CLI with the Compose plugin. Docker Desktop is available for Mac, Windows and Linux.
|
||||
* __Get latest Docker Compose and its prerequisites__:
|
||||
[Install Docker Desktop for your platform](./compose-desktop.md). This is the fastest route and you get Docker Engine and Docker CLI with the Compose plugin. Docker Desktop is available for Mac, Windows and Linux.
|
||||
|
||||
* __Install Compose plug in:__
|
||||
* __Install Compose plugin:__
|
||||
+ __(Mac, Win, Linux) Docker Desktop__: If you have Desktop installed then you already have the Compose plugin installed.
|
||||
+ __Linux systems__: To install the Docker CLI's Compose plugin,s use one of these methods of installation:
|
||||
+ Using the [convenience scripts](../../engine/install/index.md#server){: target="_blank" rel="noopener" class="_"} offered per Linux distro from the Engine install section.
|
||||
+ __Linux systems__: To install the Docker CLI's Compose plugins use one of these methods of installation:
|
||||
+ Using the [convenience scripts](../../engine/install/#server){: target="_blank" rel="noopener" class="_"} offered per Linux distro from the Engine install section.
|
||||
+ [Setting up Docker's repository](compose-plugin#install-using-the-repository) and using it to install the compose plugin package.
|
||||
+ Other scenarios, check the [Linux install](compose-plugin#installing-compose-on-linux-systems).
|
||||
+ __Windows Server__: If you want to run the Docker daemon and client directly on Microsoft Windows Server, follow the [Windows Server install instructions](compose-plugin#install-compose-on-windows-server).
|
||||
|
||||
|
||||
## Where to go next
|
||||
|
||||
- [User guide](index.md)
|
||||
- [Getting Started](../gettingstarted.md)
|
||||
- [Command line reference](../reference/index.md)
|
||||
- [Command line reference](../../reference/index.md)
|
||||
- [Compose file reference](../compose-file/index.md)
|
||||
- [Sample apps with Compose](../samples-for-compose.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -5,11 +5,14 @@ keywords: compose, orchestration, uninstall, uninstallation, docker, documentati
|
|||
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.
|
||||
|
||||
|
||||
### Uninstalling Docker Desktop
|
||||
|
||||
If you want to uninstall Compose and you have installed Docker Desktop, follow the corresponding link bellow to get instructions on how to remove Docker Desktop.
|
||||
> Please note that, unless you have other Docker instances installed in that specific environment, you would be removing Docker altogether by uninstalling the Desktop.
|
||||
If you want to uninstall Compose and you have installed Docker Desktop, follow the corresponding link bellow to get instructions on how to remove Docker Desktop.
|
||||
> Note that, unless you have other Docker instances installed on that specific environment, you would be removing Docker altogether by uninstalling the Desktop.
|
||||
|
||||
See Uninstall Docker Desktop for:
|
||||
* [Mac](../../desktop/mac/install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"}
|
||||
|
|
@ -17,7 +20,7 @@ See Uninstall Docker Desktop for:
|
|||
* [Linux](../../desktop/linux/install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"}
|
||||
|
||||
|
||||
### Uninstalling Compose CLI plugin
|
||||
### Uninstalling the Docker Compose CLI plugin
|
||||
|
||||
To remove the Compose CLI plugin, run:
|
||||
|
||||
|
|
@ -44,15 +47,15 @@ You can also use:
|
|||
|
||||
{% raw %}
|
||||
```console
|
||||
docker info --format '{{range .ClientInfo.Plugins}}{{if eq .Name "compose"}}{{.Path}}{{end}}{{end}}'
|
||||
$ docker info --format '{{range .ClientInfo.Plugins}}{{if eq .Name "compose"}}{{.Path}}{{end}}{{end}}'
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
to inspect the location of the Compose CLI plugin.
|
||||
|
||||
|
||||
> Got a "Permission denied" error?
|
||||
> Got a **Permission denied** error?
|
||||
>
|
||||
> If you get a "Permission denied" error using either of the above
|
||||
> If you get a **Permission denied** error using either of the above
|
||||
> methods, you do not have the permissions allowing you to remove
|
||||
> `docker-compose`. To force the removal, prepend `sudo` to either of the above instructions and run it again.
|
||||
|
|
|
|||
Loading…
Reference in New Issue