Install page improvement based on feedback (scenario2) (#15494)

* Install page improvement based on users and PM feedback
* Exploring a second scenario deriving from additional feedback
* Review feedback
This commit is contained in:
Dockertopia 2022-09-05 10:35:30 +01:00 committed by GitHub
parent 5291295d0d
commit ef28f705dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 264 additions and 262 deletions

View File

@ -1420,16 +1420,16 @@ manuals:
- sectiontitle: Docker Compose
section:
- path: /compose/
title: Overview of Docker Compose
- sectiontitle: Install Compose
title: Overview
- sectiontitle: Install Docker Compose
section:
- path: /compose/install/
title: Install Docker Compose
- path: /compose/install/compose-desktop/
title: Install Compose plugin through Desktop
- path: /compose/install/compose-plugin/
title: Install Docker Compose Plugin
- path: /compose/install/uninstall/
title: Install overview
- path: /compose/install/linux/
title: Install on Linux
- path: /compose/install/other/
title: Other install scenarios
- path: /compose/install/uninstall/
title: Uninstall Docker Compose
- path: /compose/gettingstarted/
title: Getting started
@ -1516,8 +1516,6 @@ manuals:
section:
- path: /docker-hub/publish/
title: Overview
- path: /docker-hub/publish/insights-analytics/
title: Insights & analytics
- path: /docker-hub/publish/publisher-center-migration/
title: Migrate content from the Publisher Center
- path: /docker-hub/release-notes/

View File

@ -1,7 +1,7 @@
---
description: Introduction and Overview of Compose
keywords: documentation, docs, docker, compose, orchestration, containers
title: Overview of Docker Compose
title: Overview
redirect_from:
- /compose/cli-command/
- /compose/networking/swarm/

View File

@ -1,23 +0,0 @@
---
description: How to install Docker Compose through Docker Desktop
keywords: compose, orchestration, install, installation, docker, documentation
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.
For download information, system requirements, and installation instructions, see:
* [Docker Desktop for Linux](../../desktop/install/linux-install.md){:target="_blank" rel="noopener" class="_"}
* [Docker Desktop for Mac](../../desktop/install/mac-install.md){:target="_blank" rel="noopener" class="_"}
* [Docker Desktop for Windows](../../desktop/install/windows-install.md){:target="_blank" rel="noopener" class="_"}
For information about Docker Desktop licensing, see [Docker Desktop License Agreement](../../subscription/index.md#docker-desktop-license-agreement){:target="_blank" rel="noopener" class="_"}.

View File

@ -1,185 +0,0 @@
---
description: How to install Docker Compose CLI plugin
keywords: compose, orchestration, install, installation, docker, documentation
toc_max: 3
title: Install Docker Compose CLI plugin
---
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 methods for installing Compose on Linux.
### Installation methods
* [Installing Docker Desktop for Linux](../../desktop/install/linux-install.md/){:target="_blank" rel="noopener" class="_"} is the easiest and recommended installation route.
Check the Desktop for Linux [supported platforms](../../desktop/install/linux-install.md/#supported-platforms){:target="_blank" rel="noopener" class="_"} page to verify the supported Linux distributions and architectures.
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 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 on this page. _This is the second best route._
* __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
> **Note**
>
>These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin.
For other Linux installation methods see [this summary](#installation-methods).
>To run Compose as a non-root user, see [Manage Docker as a non-root user](../../engine/install/linux-postinstall.md){:target="_blank" rel="noopener" class="_"}.
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 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.
```console
$ sudo apt-get update
$ sudo apt-get install docker-compose-plugin
```
Alternatively, to install a specific version of Compose CLI plugin:
a. List the versions available in your repo:
```console
$ apt-cache madison docker-compose-plugin
docker-compose-plugin | 2.3.3~ubuntu-focal | https://download.docker.com/linux/ubuntu focal/stable arm64 Packages
```
b. From the list obtained use the version string you can in the second column to specify the version you wish to install.
c. Install the selected version:
```console
$ sudo apt-get install docker-compose-plugin=<VERSION_STRING>
```
where `<VERSION_STRING>` is, for example,`2.3.3~ubuntu-focal`.
3. Verify that Docker Compose is installed correctly by checking the version.
```console
$ docker compose version
Docker Compose version v2.3.3
```
### Install the plugin manually
> **Note**
>
> These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin.
>
> Note as well this option requires you to manage upgrades manually. Whenever possible we recommend any of the other installation methods listed. For other Linux installation methods see [this summary](#installation-methods).
>To run Compose as a non-root user, see [Manage Docker as a non-root user](../../engine/install/linux-postinstall.md).
1. To download and install the Compose CLI plugin, run:
```console
$ DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
$ mkdir -p $DOCKER_CONFIG/cli-plugins
$ 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.
> To install:
>* 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:
```console
$ chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose
```
or, if you chose to install Compose for all users:
```console
$ sudo chmod +x /usr/local/lib/docker/cli-plugins/docker-compose
```
3. Test the installation.
```console
$ docker compose version
Docker Compose version {{site.compose_version}}
```
> **Note**
>
>__Compose standalone__: If you need to use Compose without installing the Docker CLI, the instructions for the standalone scenario are similar.
> Note the target folder for the binary's installation is different as well as the compose syntax used with the plugin (_space compose_) or the standalone version (_dash compose_).
1. To download and install Compose standalone, run:
```console
$ curl -SL https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
```
2. Apply executable permissions to the standalone binary in the target path for the installation.
3. Test and execute compose commands using `docker-compose`.
> **Note**
>
> If the command `docker-compose` fails after installation, check your path.
> You can also create a symbolic link to `/usr/bin` or any other directory in your path.
> For example:
> ```console
> $ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
> ```
## Install Compose on Windows Server
Follow these instructions if you are running the Docker daemon and client directly
on Microsoft Windows Server and want to install Docker Compose.
1. Run a PowerShell as an administrator.
When asked if you want to allow this app to make changes to your device, click **Yes** in order to proceed with the installation.
2. GitHub now requires TLS1.2. In PowerShell, run the following:
```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
```
3. Run the following command to download the latest release of Compose ({{site.compose_version}}):
```powershell
Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\docker-compose.exe
```
> **Note**
>
> On Windows Server 2019 you can add the Compose executable to `$Env:ProgramFiles\Docker`.
Because this directory is registered in the system `PATH`, you can run the `docker-compose --version`
command on the subsequent step with no additional configuration.
> To install a different version of Compose, substitute `{{site.compose_version}}`
> with the version of Compose you want to use.
4. Test the installation.
```console
$ docker compose version
Docker Compose version {{site.compose_version}}
```

View File

@ -2,31 +2,45 @@
description: How to install Docker Compose
keywords: compose, orchestration, install, installation, docker, documentation
title: Install Docker Compose
toc_max: 2
toc_max: 3
redirect_from:
- /compose/compose-desktop/
---
On this page you can find a summary of the available options for installing Docker Compose.
On this page you can find information on how to get and install Compose.
## Compose prerequisites
## Install Compose
* Docker Compose requires Docker Engine.
* Docker Compose plugin requires Docker CLI.
If you have Docker Desktop, you've got a full Docker installation, including Compose.
## Compose installation scenarios
You can run Compose on macOS, Windows, and 64-bit Linux. Check what installation scenario fits your needs.
You can check this by clicking on **About Docker Desktop** from the Docker menu ![whale menu](../../desktop/images/whale-x.png){: .inline}.
Are you looking to:
![about-desktop](../../desktop/images/about_desktop_versions.png){:width="750px"}
* __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.
### New Docker Installation
If you havent yet installed Docker Desktop:
{% assign yes = '![yes](/images/green-check.svg){: .inline style="height: 14px; margin: 0 auto; align=right"}' %}
| Platform | Docker Desktop |
|:---------------|:------------------------------:|
|Linux (64-bit) |{{ yes }} [Install](../../desktop/install/linux-install.md)|
|Mac |{{ yes }} [Install](../../desktop/install/mac-install.md)|
|Windows |{{ yes }} [Install](../../desktop/install/windows-install.md)|
### Pre-existing Docker Installation
If you have a Docker installation on Linux to which you want to add the Compose plugin, you can choose one of these options:
* [Install using the repository](./linux.md#install-using-the-repository)
* [Install the plugin manually](./linux.md#install-the-plugin-manually)
### Other install scenarios
For other options, see [Other install scenarios](./other.md).
* __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 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
@ -35,3 +49,6 @@ Are you looking to:
- [Compose file reference](../compose-file/index.md)
- [Sample apps with Compose](../samples-for-compose.md)
## Feedback
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="_"}.

122
compose/install/linux.md Normal file
View File

@ -0,0 +1,122 @@
---
description: How to install Docker Compose on Linux
keywords: compose, orchestration, install, installation, docker, documentation
toc_max: 3
title: Install on Linux
redirect_from:
- /compose/compose-plugin/
- /compose/compose-linux/
---
On this page you can find instructions on how to install the Compose on Linux from the command line.
## Install Compose
To install Compose:
* Option 1: [Set up Docker's repository on your Linux system](#install-using-the-repository).
* Option 2: [Install Compose manually](#install-the-plugin-manually).
### Install using the repository
> **Note**
>
> These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin.
For Compose standalone, see [Install Compose Standalone](other.md#install-compose-standalone).
If you have already set up the Docker repository, jump to step 2.
1. Set up the repository. Find distro-specific instructions in:
[Ubuntu](../../engine/install/ubuntu.md/#set-up-the-repository) |
[CentOS](../../engine/install/centos.md/#set-up-the-repository) |
[Debian](../../engine/install/debian.md/#set-up-the-repository) |
[Fefora](../../engine/install/fedora.md/#set-up-the-repository) |
[RHEL](../../engine/install/rhel.md/#set-up-the-repository) |
[SLES](../../engine/install/sles.md/#set-up-the-repository).
2. Update the package index, and install the _latest version_ of Docker Compose:
* Ubuntu, Debian:
```console
$ sudo apt-get update
$ sudo apt-get install docker-compose-plugin
```
* RPM-based distros:
```console
$ sudo yum update
$ sudo yum install docker-compose-plugin
```
3. Verify that Docker Compose is installed correctly by checking the version.
```console
$ docker compose version
Docker Compose version vN.N.N
```
Where `vN.N.N` is placeholder text standing in for the latest version.
#### Update Compose
* Ubuntu, Debian:
```console
$ sudo apt-get update
$ sudo apt-get install docker-compose-plugin
```
* RPM-based distros:
```console
$ sudo yum update
$ sudo yum install docker-compose-plugin
```
### Install the plugin manually
> **Note**
>
> This option requires you to manage upgrades manually. We recommend setting up Docker's repository for an easier maintenance.
1. To download and install the Compose CLI plugin, run:
```console
$ DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
$ mkdir -p $DOCKER_CONFIG/cli-plugins
$ 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.
To install:
* 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:
```console
$ chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose
```
or, if you chose to install Compose for all users:
```console
$ sudo chmod +x /usr/local/lib/docker/cli-plugins/docker-compose
```
3. Test the installation.
```console
$ docker compose version
Docker Compose version {{site.compose_version}}
```
## Where to go next
- [Manage Docker as a non-root user](../../engine/install/linux-postinstall.md)
- [Command line reference](../../reference/index.md)
- [Compose file reference](../compose-file/index.md)
- [Sample apps with Compose](../samples-for-compose.md)

66
compose/install/other.md Normal file
View File

@ -0,0 +1,66 @@
---
description: How to install Docker Compose - Other Scenarios
keywords: compose, orchestration, install, installation, docker, documentation
toc_max: 3
title: Other install Scenarios
---
## Install Compose Standalone
### On Linux
> **Compose standalone**
>
> Note that Compose standalone uses the _dash compose_ syntax instead of current's standard syntax (_space compose_).
For example: type `docker-compose up` when using Compose standalone, instead of `docker compose up`.
1. To download and install Compose standalone, run:
```console
$ curl -SL https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
```
2. Apply executable permissions to the standalone binary in the target path for the installation.
3. Test and execute compose commands using `docker-compose`.
> **Note**
>
> If the command `docker-compose` fails after installation, check your path.
> You can also create a symbolic link to `/usr/bin` or any other directory in your path.
> For example:
> ```console
> $ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
> ```
### On Windows Server
Follow these instructions if you are running the Docker daemon and client directly
on Microsoft Windows Server and want to install Docker Compose.
1. Run a PowerShell as an administrator.
When asked if you want to allow this app to make changes to your device, click **Yes** in order to proceed with the installation.
2. GitHub now requires TLS1.2. In PowerShell, run the following:
```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
```
3. Run the following command to download the latest release of Compose ({{site.compose_version}}):
```powershell
Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\docker-compose.exe
```
> **Note**
>
> On Windows Server 2019 you can add the Compose executable to `$Env:ProgramFiles\Docker`.
Because this directory is registered in the system `PATH`, you can run the `docker-compose --version`
command on the subsequent step with no additional configuration.
> To install a different version of Compose, substitute `{{site.compose_version}}`
> with the version of Compose you want to use.
4. Test the installation.
```console
$ docker compose version
Docker Compose version {{site.compose_version}}
```

View File

@ -5,57 +5,63 @@ 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 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.
> Note that, unless you have other Docker instances installed on that specific environment, you would be removing Docker altogether by uninstalling the Desktop.
> **Note**
>
> 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/install/mac-install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"}
* [Windows](../../desktop/install/windows-install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"}
* [Linux](../../desktop/install/linux-install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"}
[Mac](../../desktop/install/mac-install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"} |
[Windows](../../desktop/install/windows-install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"} |
[Linux](../../desktop/install/linux-install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"}.
### Uninstalling the Docker Compose CLI plugin
To remove the Compose CLI plugin, run:
Ubuntu, Debian:
```console
$ sudo apt-get remove docker-compose-plugin
```
Or, if using a different distro, use the equivalent package manager instruction to remove `docker-compose-plugin`.
RPM-based distros:
__Manually installed__
```console
$ sudo yum remove docker-compose-plugin
```
If you used `curl` to install Compose CLI plugin, to uninstall it run:
#### Manually installed
If you used `curl` to install Compose CLI plugin, to uninstall it, run:
```console
$ rm $DOCKER_CONFIG/cli-plugins/docker-compose
```
or, if you have installed Compose for all users, run:
#### Remove for all users
Or, if you have installed Compose for all users, run:
```console
$ rm /usr/local/lib/docker/cli-plugins/docker-compose
```
You can also use:
{% raw %}
```console
$ 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?
>
> 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.
#### Inspect the location of the Compose CLI plugin
To check where Compose is installed, use:
```console
$ docker info --format '{{range .ClientInfo.Plugins}}{{if eq .Name "compose"}}{{.Path}}{{end}}{{end}}'
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

View File

@ -97,7 +97,7 @@ The following image depicts the various signing keys and their relationships:
> **WARNING**
>
> Loss of the root key is **very difficult** to recover from.
> The root key once lost is not recoverable.
> Correcting this loss requires intervention from [Docker
> Support](/support/) to reset the repository state. This loss
> also requires **manual intervention** from every consumer that used a signed

View File

@ -47,8 +47,9 @@ All the Docker trust keys are stored encrypted using the passphrase you provide
on creation. Even so, you should still take care of the location where you back them up.
Good practice is to create two encrypted USB keys.
It is very important that you back up your keys to a safe, secure location. Loss
of the repository key is recoverable; loss of the root key is not.
> **Important**
> It is very important that you back up your keys to a safe, secure location. Loss of the repository key is recoverable. Loss of the root key is not.
{:important}
The Docker client stores the keys in the `~/.docker/trust/private` directory.
Before backing them up, you should `tar` them into an archive: