From f5a74852a708dba95798205dd2011c1249b089c1 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Fri, 21 Oct 2022 15:12:12 +0100 Subject: [PATCH] ENGDOCS-1020 (#15857) * ENGDOCS-1020 * fix broken links * fix build * add important note --- _data/toc.yaml | 8 +++--- compose/install/index.md | 60 +++++++++++++++++----------------------- compose/install/linux.md | 41 ++++++++++----------------- compose/install/other.md | 11 ++++---- 4 files changed, 48 insertions(+), 72 deletions(-) diff --git a/_data/toc.yaml b/_data/toc.yaml index 4c2035b518..d8f4db2e9c 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1558,13 +1558,13 @@ manuals: - sectiontitle: Install Docker Compose section: - path: /compose/install/ - title: Install overview + title: Overview - path: /compose/install/linux/ - title: Install on Linux + title: Install the Compose plugin - path: /compose/install/other/ - title: Other install scenarios + title: Install the Compose standalone - path: /compose/install/uninstall/ - title: Uninstall Docker Compose + title: Uninstall Compose - path: /compose/gettingstarted/ title: Try Docker Compose - sectiontitle: Compose V2 diff --git a/compose/install/index.md b/compose/install/index.md index 27c283651c..7601a8a94d 100644 --- a/compose/install/index.md +++ b/compose/install/index.md @@ -1,54 +1,44 @@ --- description: How to install Docker Compose keywords: compose, orchestration, install, installation, docker, documentation -title: Install Docker Compose +title: Overview toc_max: 3 redirect_from: - /compose/compose-desktop/ --- -On this page you can find information on how to get and install Compose. +This page contains summary information about the available options for getting Docker Compose. -## Install Compose +## Installation scenarios -If you have Docker Desktop, you've got a full Docker installation, including Compose. +### Scenario one: Install Docker Desktop -You can check this by clicking on **About Docker Desktop** from the Docker menu ![whale menu](../../desktop/images/whale-x.svg){: .inline}. +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. -![about-desktop](../../desktop/images/about_desktop_versions.png){:width="750px"} +Docker Desktop is available on: +- [Linux](../../desktop/install/linux-install.md) +- [Mac](../../desktop/install/mac-install.md) +- [Windows](../../desktop/install/windows-install.md) -### New Docker Installation +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} -If you haven’t yet installed Docker Desktop: +### Scenario two: Install the Compose plugin -{% assign yes = '![yes](/assets/images/green-check.svg){: .inline style="height: 14px; margin: 0 auto; align=right"}' %} +If you already have Docker Engine and Docker CLI installed, you can install the 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) -| 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)| +>Note +> +>This is only available on Linux +{: .important} +### Scenario three: Install the Compose standalone -### Pre-existing Docker Installation +You can [install the Compose standalone](other.md) on Linux or on Windows Server. -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). - - -## Where to go next - -- [Getting Started](../gettingstarted.md) -- [Command line reference](../../reference/index.md) -- [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="_"}. \ No newline at end of file +>Note +> +>This install scenario is no longer supported. +{: .important} \ No newline at end of file diff --git a/compose/install/linux.md b/compose/install/linux.md index 6573f3400c..b23b5e0411 100644 --- a/compose/install/linux.md +++ b/compose/install/linux.md @@ -2,30 +2,24 @@ description: How to install Docker Compose on Linux keywords: compose, orchestration, install, installation, docker, documentation toc_max: 3 - -title: Install on Linux +title: Install the Compose plugin 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. +On this page you can find instructions on how to install the Compose plugin 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 +To install the Compose plugin on Linux, you can either: +- [Set up Docker's repository on your Linux system](#install-using-the-repository). +- [Install Compose manually](#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. -For Compose standalone, see [Install Compose Standalone](other.md#install-compose-standalone). +For Compose standalone, see [Install Compose Standalone](other.md). -If you have already set up the Docker repository, jump to step 2. +### Install using the repository 1. Set up the repository. Find distro-specific instructions in: @@ -36,15 +30,15 @@ If you have already set up the Docker repository, jump to step 2. [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: +2. Update the package index, and install the latest version of Docker Compose: - * Ubuntu, Debian: + * For Ubuntu and Debian, run: ```console $ sudo apt-get update $ sudo apt-get install docker-compose-plugin ``` - * RPM-based distros: + * For RPM-based distros, run: ```console $ sudo yum update @@ -62,15 +56,15 @@ Where `vN.N.N` is placeholder text standing in for the latest version. #### Update Compose -To update Compose, run the following commands: +To update the Compose plugin, run the following commands: -* Ubuntu, Debian: +* For Ubuntu and Debian, run: ```console $ sudo apt-get update $ sudo apt-get install docker-compose-plugin ``` -* RPM-based distros: +* For RPM-based distros, run: ```console $ sudo yum update @@ -81,7 +75,7 @@ To update Compose, run the following commands: > **Note** > -> This option requires you to manage upgrades manually. We recommend setting up Docker's repository for an easier maintenance. +> This option requires you to manage upgrades manually. We recommend setting up Docker's repository for easier maintenance. 1. To download and install the Compose CLI plugin, run: @@ -115,10 +109,3 @@ To update Compose, run the following commands: $ 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) diff --git a/compose/install/other.md b/compose/install/other.md index 63c7e29285..d3c38aaf93 100644 --- a/compose/install/other.md +++ b/compose/install/other.md @@ -2,17 +2,16 @@ description: How to install Docker Compose - Other Scenarios keywords: compose, orchestration, install, installation, docker, documentation toc_max: 3 - -title: Other install Scenarios +title: Install the Compose standalone --- -## Install Compose Standalone +On this page you can find instructions on how to install the Compose standalone on Linux or Windows Server, from the command line. ### 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`. +> Note that Compose standalone uses the `-compose` syntax instead of the current standard syntax `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 @@ -35,7 +34,7 @@ For example: type `docker-compose up` when using Compose standalone, instead of 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. +1. Run 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: