From 7eb898343140d2c786dc30756871a92d2b8e9f1a Mon Sep 17 00:00:00 2001 From: dribeiro Date: Wed, 25 May 2022 16:42:08 +0100 Subject: [PATCH 1/7] Revisiting Compose installation --- compose/install.md | 284 +++++++++++++++++++++------------------------ 1 file changed, 134 insertions(+), 150 deletions(-) diff --git a/compose/install.md b/compose/install.md index e1db0106046d..9ac19675cf7c 100644 --- a/compose/install.md +++ b/compose/install.md @@ -7,160 +7,113 @@ toc_max: 2 This page contains information on how to install Docker Compose. You can run Compose on macOS, Windows, and 64-bit Linux. -## Prerequisites - -Docker Compose relies on Docker Engine for any meaningful work, so make sure you -have Docker Engine installed either locally or remote, depending on your setup. -- On desktop systems like Docker Desktop for Mac and Windows, Docker Compose is -included as part of those desktop installs. - -- On Linux systems, you can install Docker Compose with the Docker Engine using the -[convenience script](../engine/install/index.md#server){: target="_blank" rel="noopener" class="_"}. Select the install Docker Engine page for your distribution and then look for instructions on installing using the convenience script. -Otherwise, you should first install the [Docker Engine](../engine/install/index.md#server){: target="_blank" rel="noopener" class="_"} -for your OS and then refer to this page for -instructions on installing Compose on -Linux systems. +## Prerequisites -- To run Compose as a non-root user, see [Manage Docker as a non-root user](../engine/install/linux-postinstall.md). +* Docker Compose requires Docker Engine. +* Docker Compose plugin requires Docker CLI. ## Install Compose -Follow the instructions below to install Compose on Mac, Windows, Windows Server, or Linux systems. +Check what installation scenario fits your needs. Are you looking to: -> Install a different version -> -> The instructions below outline installation of the current stable release -> (**{{site.compose_version}}**) of Compose. To install a different version of -> Compose, replace the given release number with the one that you want. -> -> Compose releases are also listed and available for direct download on the -> [Compose repository release page on GitHub](https://github.com/docker/compose/releases){:target="_blank" rel="noopener" class="_"}. -> -> To install the Python version of Compose, follow instructions in the [Compose v1 GitHub branch](https://github.com/docker/compose/blob/master/INSTALL.md){: target="_blank" rel="noopener" class="_"}. +* __Get latest Compose and pre-requirements of the bat__ +Install Docker Desktop for your platform. This is the fastest route and you get Docker Engine, Docker CLI and Compose plugin. +Docker Desktop is available for Mac, Windows and Linux. + +* __Install Compose plug in:__ + + If you got __Docker Desktop__ you're all set, no need to install anything separatedly. + + __Windows Server__: If you want to run the Docker daemon and client directly on Microsoft Windows Server, follow the [Windows Server install instructions](#install-compose-on-windows-server) + + __Linux systems__: + + To install Docker Compose with the Docker Engine we recommend [setting up Docker's repositories](#install-using-the-repository) or, + + Using the [convenience scripts](../../engine/install/#server){: target="_blank" rel="noopener" class="_"} offered per Linux distro from the Engine install section. + + Other scenarios, check the [Linux install](#installing-compose-on-linux-systems) -
-
-### Install Compose on macOS - -**Docker Desktop for Mac** includes Compose along -with other Docker apps, so Mac users do not need to install Compose separately. -For installation instructions, see [Install Docker Desktop on Mac](../desktop/mac/install.md). +
+
-
-
+### Installing Docker Desktop -### Install Compose on Windows desktop systems +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 and a list of key features in the [Docker Desktop Overview](../desktop/index.md). -**Docker Desktop for Windows** includes Compose -along with other Docker apps, so most Windows users do not need to -install Compose separately. For install instructions, see [Install Docker Desktop on Windows](../desktop/windows/install.md). +Docker Desktop is available for Mac, Windows and Linux. +For download information, system requirements, and installation instructions, see: -If you are running the Docker daemon and client directly on Microsoft -Windows Server, follow the instructions in the Windows Server tab. +* [Docker Desktop for Linux](../../desktop/linux/install.md) +* [Docker Desktop for Mac](../../desktop/mac/install.md) +* [Docker Desktop for Windows](../../desktop/windows/install.md) +For information about Docker Desktop licensing, see [Docker Desktop License Agreement](../../subscription/index.md#docker-desktop-license-agreement).
-
-### 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. Start an "elevated" PowerShell (run it as administrator). - Search for PowerShell, right-click, and choose - **Run as administrator**. When asked if you want to allow this app - to make changes to your device, click **Yes**. - -2. In PowerShell, since GitHub now requires TLS1.2, run the following: - - ```powershell - [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 - ``` - - Then run the following command to download the current stable release of - Compose ({{site.compose_version}}): +
+{: id="tabtest"} - ```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 - ``` +### Installing Compose on Linux systems - > **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. +* Installing Docker Desktop for Linux is the easiest and recommended route. Check the [supported platforms](../desktop/linux/install.md/#supported-platforms) page to verify the supported Linux distributions and architectures. - > To install a different version of Compose, substitute `{{site.compose_version}}` - > with the version of Compose you want to use. +You can also: -3. Test the installation. +* __Use the automated convenience scripts__ (for testing and development environments). +These scripts will get you Docker Engine and Docker CLI with the Compose plugin. +Choose your Linux distribution from the [Docker Engine install](..engine/install/) and follow the instructions available there. - ```console - $ docker compose version - Docker Compose version {{site.compose_version}} - ``` -
-
+* __Set up Dockers repositories__ and install from them. This is option is second-best regarding ease of installation and upgrading. See the [Install using the repository](#install-using-the-repository) section in this page. -### Install Compose on Linux systems +* __Use a package manager__. See [convenience scripts](#install-using-the-convenience-script) for instructions. -You can install Docker Compose in different ways, depending on your needs: +* By downloading and __installing the compose plugin binary manually__. Note that this option requires you to manage upgrades manually as well. See the [Install the Plugin manually](#install-the-binary-manually) section in this page. -- In testing and development environments, some users choose to use automated - [convenience scripts](#install-using-the-convenience-script) to install Docker. -- Most users [set up Docker's repositories](#install-using-the-repository) and - install from them, for ease of installation and upgrade tasks. This is the - recommended approach. -- Some users [download and install the binary](#install-the-binary-manually), - and manage upgrades manually. +#### Install using the repository -#### Install using the convenience script -As Docker Compose is now part of the Docker CLI it can be installed via a convenience script with Docker Engine and the CLI. -[Choose your Linux distribution](../engine/install/index.md#server) and follow the instructions. +>These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin. +For other scenarios check [this summary](#install-compose). +>To run Compose as a non-root user, see [Manage Docker as a non-root user](../engine/install/linux-postinstall.md). -#### Install using the repository -If you already follow the instructions to install Docker Engine, Docker Compose should already be installed. -Otherwise, you can set up the Docker repository as mentioned in the Docker Engine installation, [choose your Linux distribution](../engine/install/index.md#server) and go to the `Set up the repository` section. +If you have already set up the Docker repository jump to step 2. -When finished +1. Go to the `Set up the repository` section of your corresponding [Linux distribution](../engine/install/index.md#server) found in the Docker Engine installation pages. -1. Update the `apt` package index, and install the _latest version_ of Docker Compose, or go to the next step to install a specific version: +2. Update the `apt` package index, and install the _latest version_ of Docker Compose: ```console $ sudo apt-get update $ sudo apt-get install docker-compose-plugin ``` + + Alternatively, to install a specific version of Docker Engine: + + a. List the versions available in your repo: -2. To install a _specific version_ of Docker Engine, list the available versions - in the repo, then select and install: + ```console + $ apt-cache madison docker-compose-plugin - a. List the versions available in your repo: + docker-compose-plugin | 2.3.3~ubuntu-focal | https://download.docker.com/linux/ubuntu focal/stable arm64 Packages + ``` - ```console - $ apt-cache madison docker-compose-plugin + 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: - docker-compose-plugin | 2.3.3~ubuntu-focal | https://download.docker.com/linux/ubuntu focal/stable arm64 Packages - ``` - b. Install a specific version using the version string from the second column, - for example, `2.3.3~ubuntu-focal`. - - ```console - $ sudo apt-get install docker-compose-plugin= - ``` + ```console + $ sudo apt-get install docker-compose-plugin= + ``` + where is, for example,`2.3.3~ubuntu-focal`. 3. Verify that Docker Compose is installed correctly by checking the version. @@ -169,16 +122,16 @@ When finished Docker Compose version v2.3.3 ``` +#### Install the Plugin manually + +> +>These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin. +For other scenarios check [this summary](#install-compose). -#### Install the binary manually +>To run Compose as a non-root user, see [Manage Docker as a non-root user](../engine/install/linux-postinstall.md). -On Linux, you can download the Docker Compose binary from the -[Compose repository release page on GitHub](https://github.com/docker/compose/releases){:target="_blank" rel="noopener" class="_"} and copying it into `$HOME/.docker/cli-plugins` as `docker-compose`. -Follow the instructions from the link, which involve running the `curl` command -in your terminal to download the binaries. These step-by-step instructions are -also included below. -1. Run this command to download the current stable release of Docker Compose: +1. To download and install the Compose plugin, run: ```console $ DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker} @@ -186,18 +139,19 @@ also included below. $ 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 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`. - - - > To install a different version of Compose, substitute `{{site.compose_version}}` - > with the version of Compose you want to use. + This command downloads the current stable 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 choose to install Compose for all users + or, if you chose to install Compose for all users: + ```console $ sudo chmod +x /usr/local/lib/docker/cli-plugins/docker-compose ``` @@ -208,52 +162,76 @@ also included below. $ docker compose version Docker Compose version {{site.compose_version}} ``` -
-
+> __Compose standalone__: If you need to use Compose without installing the Docker CLI, the instructions for installing the standalone binary are similar. -### Install Compose as standalone binary on Linux systems - -You can use Compose as a standalone binary without installing the Docker CLI. - -1. Run this command to download the current stable release of Docker 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 ``` - - > To install 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 - $ sudo chmod +x /usr/local/bin/docker-compose - ``` - +2. Apply executable permissions to the standalone binary in target path for the installation. +3. Test and execute compose commands use, `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: + > 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 > ``` +
-3. Test the installation. +
+ +### 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. Start an "elevated" PowerShell (run it as administrator). + Search for PowerShell, right-click, and choose + **Run as administrator**. When asked if you want to allow this app + to make changes to your device, click **Yes**. + +2. In PowerShell, since GitHub now requires TLS1.2, run the following: + + ```powershell + [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 + ``` + + Then run the following command to download the current stable 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. + +3. Test the installation. ```console - $ docker-compose --version + $ docker compose version Docker Compose version {{site.compose_version}} ```
-
----- +
+ +### Uninstalling Docker Desktop + +* See Uninstall Docker Desktop for: + + [Mac](../../desktop/mac/install/#uninstall-docker-desktop) + + [Windows](../../desktop/windows/install/#uninstall-docker-desktop) + + [Linux](../../desktop/linux/install.md/#uninstall-docker-desktop) -## Uninstallation + +* __Other scenarios__: To uninstall Docker Compose if you installed using `curl`: ```console @@ -272,6 +250,12 @@ $ sudo rm /usr/local/lib/docker/cli-plugins/docker-compose > methods, you probably do not have the proper permissions to remove > `docker-compose`. To force the removal, prepend `sudo` to either of the above > commands and run again. +
+
+ +---- + + ## Where to go next From d9a632c2fe72da595a1591c2a433b97e790ae0b1 Mon Sep 17 00:00:00 2001 From: dribeiro Date: Thu, 26 May 2022 18:15:39 +0100 Subject: [PATCH 2/7] Revisited Compose Install page --- _data/toc.yaml | 14 +- compose/install.md | 267 ----------------------------- compose/install/compose-desktop.md | 24 +++ compose/install/compose-plugin.md | 185 ++++++++++++++++++++ compose/install/index.md | 39 +++++ compose/install/uninstall.md | 38 ++++ 6 files changed, 296 insertions(+), 271 deletions(-) delete mode 100644 compose/install.md create mode 100644 compose/install/compose-desktop.md create mode 100644 compose/install/compose-plugin.md create mode 100644 compose/install/index.md create mode 100644 compose/install/uninstall.md diff --git a/_data/toc.yaml b/_data/toc.yaml index ef182ff193a6..8179056836a4 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1390,7 +1390,6 @@ manuals: title: Engine 1.13 and earlier - path: /engine/deprecated/ title: Deprecated features - - path: /buildx/working-with-buildx/ title: Docker Buildx - path: /engine/context/working-with-contexts/ @@ -1399,13 +1398,20 @@ manuals: title: Docker Scan - path: /engine/sbom/ title: Docker SBOM (Experimental) - - sectiontitle: Docker Compose section: - path: /compose/ title: Overview of Docker Compose - - path: /compose/install/ - title: Install Compose + - sectiontitle: Install 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: Uninstall Docker Compose - path: /compose/gettingstarted/ title: Getting started - path: /compose/environment-variables/ diff --git a/compose/install.md b/compose/install.md deleted file mode 100644 index 9ac19675cf7c..000000000000 --- a/compose/install.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -description: How to install Docker Compose -keywords: compose, orchestration, install, installation, docker, documentation -title: Install Docker Compose -toc_max: 2 ---- - -This page contains information on how to install Docker Compose. You can run Compose on macOS, Windows, and 64-bit Linux. - - -## Prerequisites - -* Docker Compose requires Docker Engine. -* Docker Compose plugin requires Docker CLI. - -## Install Compose - -Check what installation scenario fits your needs. Are you looking to: - -* __Get latest Compose and pre-requirements of the bat__ -Install Docker Desktop for your platform. This is the fastest route and you get Docker Engine, Docker CLI and Compose plugin. -Docker Desktop is available for Mac, Windows and Linux. - -* __Install Compose plug in:__ - + If you got __Docker Desktop__ you're all set, no need to install anything separatedly. - + __Windows Server__: If you want to run the Docker daemon and client directly on Microsoft Windows Server, follow the [Windows Server install instructions](#install-compose-on-windows-server) - + __Linux systems__: - + To install Docker Compose with the Docker Engine we recommend [setting up Docker's repositories](#install-using-the-repository) or, - + Using the [convenience scripts](../../engine/install/#server){: target="_blank" rel="noopener" class="_"} offered per Linux distro from the Engine install section. - + Other scenarios, check the [Linux install](#installing-compose-on-linux-systems) - - - -
-
- -### Installing 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 and a list of key features in the [Docker Desktop Overview](../desktop/index.md). - -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) -* [Docker Desktop for Mac](../../desktop/mac/install.md) -* [Docker Desktop for Windows](../../desktop/windows/install.md) - -For information about Docker Desktop licensing, see [Docker Desktop License Agreement](../../subscription/index.md#docker-desktop-license-agreement). -
- -
-{: id="tabtest"} - -### Installing Compose on Linux systems - -* Installing Docker Desktop for Linux is the easiest and recommended route. Check the [supported platforms](../desktop/linux/install.md/#supported-platforms) page to verify the supported Linux distributions and architectures. - -You can also: - -* __Use the automated convenience scripts__ (for testing and development environments). -These scripts will get you Docker Engine and Docker CLI with the Compose plugin. -Choose your Linux distribution from the [Docker Engine install](..engine/install/) and follow the instructions available there. - -* __Set up Dockers repositories__ and install from them. This is option is second-best regarding ease of installation and upgrading. See the [Install using the repository](#install-using-the-repository) section in this page. - -* __Use a package manager__. See [convenience scripts](#install-using-the-convenience-script) for instructions. - -* By downloading and __installing the compose plugin binary manually__. Note that this option requires you to manage upgrades manually as well. See the [Install the Plugin manually](#install-the-binary-manually) section in this page. - - -#### Install using the repository - - ->These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin. -For other scenarios check [this summary](#install-compose). - ->To run Compose as a non-root user, see [Manage Docker as a non-root user](../engine/install/linux-postinstall.md). - - -If you have already set up the Docker repository jump to step 2. - -1. Go to the `Set up the repository` section of your corresponding [Linux distribution](../engine/install/index.md#server) found in the Docker Engine installation pages. - -2. Update the `apt` package index, and install the _latest version_ of Docker Compose: - - ```console - $ sudo apt-get update - $ sudo apt-get install docker-compose-plugin - ``` - - Alternatively, to install a specific version of Docker Engine: - - 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= - ``` - where 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 - -> ->These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin. -For other scenarios check [this summary](#install-compose). - ->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 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 current stable 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}} - ``` - -> __Compose standalone__: If you need to use Compose without installing the Docker CLI, the instructions for installing the standalone binary are similar. - -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 target path for the installation. -3. Test and execute compose commands use, `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. Start an "elevated" PowerShell (run it as administrator). - Search for PowerShell, right-click, and choose - **Run as administrator**. When asked if you want to allow this app - to make changes to your device, click **Yes**. - -2. In PowerShell, since GitHub now requires TLS1.2, run the following: - - ```powershell - [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 - ``` - - Then run the following command to download the current stable 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. - -3. Test the installation. - - ```console - $ docker compose version - Docker Compose version {{site.compose_version}} - ``` -
- -
- -### Uninstalling Docker Desktop - -* See Uninstall Docker Desktop for: - + [Mac](../../desktop/mac/install/#uninstall-docker-desktop) - + [Windows](../../desktop/windows/install/#uninstall-docker-desktop) - + [Linux](../../desktop/linux/install.md/#uninstall-docker-desktop) - - - -* __Other scenarios__: -To uninstall Docker Compose if you installed using `curl`: - -```console -$ rm $DOCKER_CONFIG/cli-plugins/docker-compose -``` - -or if you choose to install Compose for all users - -```console -$ sudo rm /usr/local/lib/docker/cli-plugins/docker-compose -``` - -> Got a "Permission denied" error? -> -> If you get a "Permission denied" error using either of the above -> methods, you probably do not have the proper permissions to remove -> `docker-compose`. To force the removal, prepend `sudo` to either of the above -> commands and run again. -
-
- ----- - - - - -## Where to go next - -- [User guide](index.md) -- [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) diff --git a/compose/install/compose-desktop.md b/compose/install/compose-desktop.md new file mode 100644 index 000000000000..6529f1bd26f9 --- /dev/null +++ b/compose/install/compose-desktop.md @@ -0,0 +1,24 @@ +--- +description: How to install Docker Compose through Docker Desktop +keywords: compose, orchestration, install, installation, docker, documentation + +title: Install Docker Compose through Docker Desktop +--- + + +## Installing 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 and a list of key features in the [Docker Desktop Overview](../../desktop/index.md){:target="_blank" rel="noopener" class="_"}. + +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="_"} +* [Docker Desktop for Mac](../../desktop/mac/install.md){:target="_blank" rel="noopener" class="_"} +* [Docker Desktop for Windows](../../desktop/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="_"}. + + + diff --git a/compose/install/compose-plugin.md b/compose/install/compose-plugin.md new file mode 100644 index 000000000000..30a6c810a4a2 --- /dev/null +++ b/compose/install/compose-plugin.md @@ -0,0 +1,185 @@ +--- +description: How to install Docker Compose plugin +keywords: compose, orchestration, install, installation, docker, documentation +toc_max: 3 + +title: Install Docker Compose Plugin +--- + +## Prerequisites + +* Docker Compose requires Docker Engine. +* Docker Compose plugin requires Docker CLI. + + +## 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. +Be sure to, when asked if you want to allow this app to make changes to your device, to click **Yes**. + +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 current 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. + +3. Test the installation. + + ```console + $ docker compose version + Docker Compose version {{site.compose_version}} + ``` + +## Installing Compose on Linux systems + +> For Docker Desktop for Linux installation, see [Docker Desktop for Linux](../../desktop/linux/install.md/){:target="_blank" rel="noopener" class="_"}. + +__Other methods__ + +The following methods are possible: + +* Installing Docker Desktop for Linux. It's 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. + +* __Using the automated convenience scripts__ (for testing and development environments). +These scripts will get you Docker Engine and Docker CLI with the Compose plugin. +Choose your Linux distribution from the [Docker Engine install](../../../engine/install/){:target="_blank" rel="noopener" class="_"} and follow the instructions available there. + +* __Setting up Docker's repository__ and using it to install Compose. See the [Install using the repository](#install-using-the-repository) section in this page. + + +* Downloading and __installing the Compose plugin binary manually__. Note that this option requires you to manage upgrades manually as well. See the [Install the Plugin manually](#install-the-plugin-manually) section in this page. + + +### 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 scenarios check [this summary](../install/index.md#install-compose). + +>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 in the Docker Engine installation pages to check the instructions. + + Once that is done: + +2. Update the `apt` package index, and install the _latest version_ of Docker Compose: + + ```console + $ sudo apt-get update + $ sudo apt-get install docker-compose-plugin + ``` + + Alternatively, to install a specific version of Docker Engine: + + 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= + ``` + where `` 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. +For other scenarios check [this summary](../install/index.md#install-compose). + +>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 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 current stable 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 installing the standalone binary 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 +> ``` + diff --git a/compose/install/index.md b/compose/install/index.md new file mode 100644 index 000000000000..79a2602d7d8e --- /dev/null +++ b/compose/install/index.md @@ -0,0 +1,39 @@ +--- +description: How to install Docker Compose +keywords: compose, orchestration, install, installation, docker, documentation +title: Install Docker Compose +toc_max: 2 +--- + +This page contains information on how to install Docker Compose. You can run Compose on macOS, Windows, and 64-bit Linux. + + +## Prerequisites + +* Docker Compose requires Docker Engine. +* Docker Compose plugin requires Docker CLI. + +## Install Compose + +Check what installation scenario fits your needs. Are you looking to: + +* __Get latest Compose and pre-requirements of the bat__: +Install Docker Desktop for your platform. This is the fastest route and you get Docker Engine, Docker CLI with the Compose plugin. +Docker Desktop is available for Mac, Windows and Linux. + +* __Install Compose plug in:__ + + __(Mac, Win, Linux) Docker Desktop__: If you got Desktop installed then you're all set, no need to install anything separatedly. + + __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) + + __Linux systems__ - other methods of intallation: + + To install Docker Compose with the Docker Engine we recommend [setting up Docker's repository](compose-plugin#install-using-the-repository) or, + + Using the [convenience scripts](../../../engine/install/#server){: target="_blank" rel="noopener" class="_"} offered per Linux distro from the Engine install section. + + Other scenarios, check the [Linux install](compose-plugin#installing-compose-on-linux-systems). + + +## Where to go next + +- [User guide](index.md) +- [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) diff --git a/compose/install/uninstall.md b/compose/install/uninstall.md new file mode 100644 index 000000000000..f0fac058fd4f --- /dev/null +++ b/compose/install/uninstall.md @@ -0,0 +1,38 @@ +--- +description: How to uninstall Docker Compose +keywords: compose, orchestration, uninstall, uninstallation, docker, documentation + +title: 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. + +See Uninstall Docker Desktop for: +* [Mac](../../desktop/mac/install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"} +* [Windows](../../desktop/windows/install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"} +* [Linux](../../desktop/linux/install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"} + + +#### Other scenarios + +If you used `curl` to install Compose, to uninstall it run: + +```console +$ rm $DOCKER_CONFIG/cli-plugins/docker-compose +``` + +or, if you have installed Compose for all users, run: + +```console +$ rm /usr/local/lib/docker/cli-plugins/docker-compose +``` + +> 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. From 8bc37c2fa59b07368a9ddc22a0e69aa84b51c5d6 Mon Sep 17 00:00:00 2001 From: dribeiro Date: Wed, 1 Jun 2022 11:56:39 +0100 Subject: [PATCH 3/7] Incorporating reviews feedback --- compose/install/compose-desktop.md | 5 ++- compose/install/compose-plugin.md | 51 ++++++++++++++++-------------- compose/install/index.md | 16 +++++----- compose/install/uninstall.md | 24 ++++++++++++-- 4 files changed, 59 insertions(+), 37 deletions(-) diff --git a/compose/install/compose-desktop.md b/compose/install/compose-desktop.md index 6529f1bd26f9..579e6f31bf20 100644 --- a/compose/install/compose-desktop.md +++ b/compose/install/compose-desktop.md @@ -2,14 +2,13 @@ description: How to install Docker Compose through Docker Desktop keywords: compose, orchestration, install, installation, docker, documentation -title: Install Docker Compose through Docker Desktop +title: Install Compose through Docker Desktop --- -## Installing 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 and a list of key features in the [Docker Desktop Overview](../../desktop/index.md){:target="_blank" rel="noopener" class="_"}. +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: diff --git a/compose/install/compose-plugin.md b/compose/install/compose-plugin.md index 30a6c810a4a2..791505b2fe7b 100644 --- a/compose/install/compose-plugin.md +++ b/compose/install/compose-plugin.md @@ -1,12 +1,16 @@ --- -description: How to install Docker Compose plugin +description: How to install Docker Compose CLI plugin keywords: compose, orchestration, install, installation, docker, documentation toc_max: 3 -title: Install Docker Compose Plugin +title: Install Docker Compose CLI plugin --- -## Prerequisites +In this page you can find instructions on how to install Compose Plugin for Docker CLI in: +* Windows Server +* Linux + +## Compose Prerequisites * Docker Compose requires Docker Engine. * Docker Compose plugin requires Docker CLI. @@ -14,20 +18,19 @@ title: Install Docker Compose Plugin ## 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. -Be sure to, when asked if you want to allow this app to make changes to your device, to click **Yes**. +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 current release of Compose ({{site.compose_version}}): +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 @@ -51,22 +54,24 @@ Be sure to, when asked if you want to allow this app to make changes to your dev ## Installing Compose on Linux systems -> For Docker Desktop for Linux installation, see [Docker Desktop for Linux](../../desktop/linux/install.md/){:target="_blank" rel="noopener" class="_"}. +In this section you can find various routes for installing Compose in Linux. -__Other methods__ +### Installation Methods -The following methods are possible: +* [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. -* Installing Docker Desktop for Linux. It's 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. -* __Using the automated convenience scripts__ (for testing and development environments). -These scripts will get you Docker Engine and Docker CLI with the Compose plugin. -Choose your Linux distribution from the [Docker Engine install](../../../engine/install/){:target="_blank" rel="noopener" class="_"} and follow the instructions available there. +The following other methods are possible: -* __Setting up Docker's repository__ and using it to install Compose. See the [Install using the repository](#install-using-the-repository) section in this page. +* __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._ +* __Setting up Docker's repository__ and using it to install Compose. See the [Install using the repository](#install-using-the-repository) section in this page. _This is the second best route._ -* Downloading and __installing the Compose plugin binary manually__. Note that this option requires you to manage upgrades manually as well. See the [Install the Plugin manually](#install-the-plugin-manually) section in this page. +* __Installing the Compose CLI 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._ ### Install using the repository @@ -74,7 +79,7 @@ Choose your Linux distribution from the [Docker Engine install](../../../engine/ > **Note** > >These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin. -For other scenarios check [this summary](../install/index.md#install-compose). +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="_"}. @@ -83,8 +88,6 @@ 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. - Once that is done: - 2. Update the `apt` package index, and install the _latest version_ of Docker Compose: ```console @@ -92,7 +95,7 @@ If you have already set up the Docker repository jump to step 2. $ sudo apt-get install docker-compose-plugin ``` - Alternatively, to install a specific version of Docker Engine: + Alternatively, to install a specific version of Compose CLI plugin: a. List the versions available in your repo: @@ -125,12 +128,12 @@ If you have already set up the Docker repository jump to step 2. > **Note** > >These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin. -For other scenarios check [this summary](../install/index.md#install-compose). +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 plugin, run: +1. To download and install the Compose CLI plugin, run: ```console $ DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker} @@ -138,7 +141,7 @@ For other scenarios check [this summary](../install/index.md#install-compose). $ 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 current stable 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`. @@ -164,10 +167,10 @@ For other scenarios check [this summary](../install/index.md#install-compose). > **Note** > ->__Compose standalone__: If you need to use Compose without installing the Docker CLI, the instructions for installing the standalone binary are similar. +>__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: +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 ``` diff --git a/compose/install/index.md b/compose/install/index.md index 79a2602d7d8e..d3038bbed174 100644 --- a/compose/install/index.md +++ b/compose/install/index.md @@ -5,24 +5,24 @@ title: Install Docker Compose toc_max: 2 --- -This page contains information on how to install Docker Compose. You can run Compose on macOS, Windows, and 64-bit Linux. +In this page you can find a summary of the available options for installing Compose. - -## Prerequisites +## Compose Prerequisites * Docker Compose requires Docker Engine. * Docker Compose plugin requires Docker CLI. -## Install Compose +## Compose Installation Scenarios +You can run Compose on macOS, Windows, and 64-bit Linux. Check what installation scenario fits your needs. -Check what installation scenario fits your needs. Are you looking to: +Are you looking to: -* __Get latest Compose and pre-requirements of the bat__: -Install Docker Desktop for your platform. This is the fastest route and you get Docker Engine, Docker CLI with the Compose plugin. +* __Get latest Compose and its prerequisites right of the bat__: +Install Docker Desktop for your platform. 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:__ - + __(Mac, Win, Linux) Docker Desktop__: If you got Desktop installed then you're all set, no need to install anything separatedly. + + __(Mac, Win, Linux) Docker Desktop__: If you have Desktop installed then you already have the Compose plugin installed. + __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) + __Linux systems__ - other methods of intallation: + To install Docker Compose with the Docker Engine we recommend [setting up Docker's repository](compose-plugin#install-using-the-repository) or, diff --git a/compose/install/uninstall.md b/compose/install/uninstall.md index f0fac058fd4f..d1544c94e864 100644 --- a/compose/install/uninstall.md +++ b/compose/install/uninstall.md @@ -17,9 +17,18 @@ See Uninstall Docker Desktop for: * [Linux](../../desktop/linux/install.md/#uninstall-docker-desktop){:target="_blank" rel="noopener" class="_"} -#### Other scenarios +### Uninstalling Compose CLI plugin -If you used `curl` to install Compose, to uninstall it run: +To remove the Compose CLI plugin, run: + +```console +$ sudo apt-get remove docker-compose-plugin +``` +Or, if using a different distro, use the equivalent package manager to remove `docker-compose-plugin`. + +__Manually installed__ + +If you used `curl` to install Compose CLI plugin, to uninstall it run: ```console $ rm $DOCKER_CONFIG/cli-plugins/docker-compose @@ -31,6 +40,17 @@ or, if you have installed Compose for all users, run: $ 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 From d9bf546366fde388e39da86bd00d7478eab8dd3f Mon Sep 17 00:00:00 2001 From: Dora Ribeiro <103652162+dockertopia@users.noreply.github.com> Date: Wed, 1 Jun 2022 12:01:34 +0100 Subject: [PATCH 4/7] Update win serv instruction Changing windows server installation instructions to apply to installing Compose a CLI plugin. Co-authored-by: Stefan Scherer --- compose/install/compose-plugin.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/compose/install/compose-plugin.md b/compose/install/compose-plugin.md index 791505b2fe7b..63114770c17d 100644 --- a/compose/install/compose-plugin.md +++ b/compose/install/compose-plugin.md @@ -33,7 +33,7 @@ When asked if you want to allow this app to make changes to your device, click * 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 + Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\cli-plugins\docker-compose.exe ``` > **Note** From 44e402a458e6873c2b3a1ce3e7fc8d3a039583fe Mon Sep 17 00:00:00 2001 From: Dora Ribeiro <103652162+dockertopia@users.noreply.github.com> Date: Wed, 1 Jun 2022 12:02:01 +0100 Subject: [PATCH 5/7] Update win server instructions Changing windows server installation instructions to apply to installing Compose a CLI plugin. Co-authored-by: Stefan Scherer --- compose/install/compose-plugin.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/compose/install/compose-plugin.md b/compose/install/compose-plugin.md index 63114770c17d..5a73339d7e62 100644 --- a/compose/install/compose-plugin.md +++ b/compose/install/compose-plugin.md @@ -38,8 +38,8 @@ When asked if you want to allow this app to make changes to your device, click * > **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` + > On Windows Server 2019 you can add the Compose CLI plugin to `$Env:ProgramFiles\Docker\cli-plugins`. + Because this directory is used for Docker CLI plugin, 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}}` From c9a74e313765fb0456839dbfe249d7ca4bf4b09f Mon Sep 17 00:00:00 2001 From: dribeiro Date: Thu, 2 Jun 2022 11:44:55 +0100 Subject: [PATCH 6/7] Review feedback edits --- compose/install/compose-plugin.md | 88 +++++++++++++++++-------------- compose/install/index.md | 13 +++-- compose/install/uninstall.md | 2 +- 3 files changed, 54 insertions(+), 49 deletions(-) diff --git a/compose/install/compose-plugin.md b/compose/install/compose-plugin.md index 5a73339d7e62..864ba676bbd3 100644 --- a/compose/install/compose-plugin.md +++ b/compose/install/compose-plugin.md @@ -7,8 +7,9 @@ title: Install Docker Compose CLI plugin --- In this page you can find instructions on how to install Compose Plugin for Docker CLI in: -* Windows Server * Linux +* Windows Server + ## Compose Prerequisites @@ -16,42 +17,6 @@ In this page you can find instructions on how to install Compose Plugin for Dock * Docker Compose plugin requires Docker CLI. -## 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\cli-plugins\docker-compose.exe - ``` - - > **Note** - > - > On Windows Server 2019 you can add the Compose CLI plugin to `$Env:ProgramFiles\Docker\cli-plugins`. - Because this directory is used for Docker CLI plugin, 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. - -3. Test the installation. - - ```console - $ docker compose version - Docker Compose version {{site.compose_version}} - ``` - ## Installing Compose on Linux systems In this section you can find various routes for installing Compose in Linux. @@ -69,9 +34,9 @@ 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._ -* __Setting up Docker's repository__ and using it to install Compose. 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 in this page. _This is the second best route._ -* __Installing the Compose CLI 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 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._ ### Install using the repository @@ -90,6 +55,9 @@ If you have already set up the Docker repository jump to step 2. 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 @@ -127,8 +95,9 @@ If you have already set up the Docker repository jump to step 2. > **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). +> 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). @@ -186,3 +155,40 @@ For other Linux installation methods see [this summary](#installation-methods). > $ 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. + +3. Test the installation. + + ```console + $ docker compose version + Docker Compose version {{site.compose_version}} + ``` + diff --git a/compose/install/index.md b/compose/install/index.md index d3038bbed174..2bad9499d393 100644 --- a/compose/install/index.md +++ b/compose/install/index.md @@ -18,16 +18,15 @@ You can run Compose on macOS, Windows, and 64-bit Linux. Check what installation Are you looking to: * __Get latest Compose and its prerequisites right of the bat__: -Install Docker Desktop for your platform. 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 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:__ + __(Mac, Win, Linux) Docker Desktop__: If you have Desktop installed then you already have the Compose plugin installed. - + __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) - + __Linux systems__ - other methods of intallation: - + To install Docker Compose with the Docker Engine we recommend [setting up Docker's repository](compose-plugin#install-using-the-repository) or, - + Using the [convenience scripts](../../../engine/install/#server){: target="_blank" rel="noopener" class="_"} offered per Linux distro from the Engine install section. - + Other scenarios, check the [Linux install](compose-plugin#installing-compose-on-linux-systems). + + __Linux systems__: To install the Docker CLI's Compose plugin,s 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 diff --git a/compose/install/uninstall.md b/compose/install/uninstall.md index d1544c94e864..3b89f67a98f3 100644 --- a/compose/install/uninstall.md +++ b/compose/install/uninstall.md @@ -24,7 +24,7 @@ To remove the Compose CLI plugin, run: ```console $ sudo apt-get remove docker-compose-plugin ``` -Or, if using a different distro, use the equivalent package manager to remove `docker-compose-plugin`. +Or, if using a different distro, use the equivalent package manager instruction to remove `docker-compose-plugin`. __Manually installed__ From ff671f447789d795df33389d885a0e5c191ec06e Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Thu, 2 Jun 2022 18:54:08 +0200 Subject: [PATCH 7/7] Fix links after moving compose/install.md Signed-off-by: Sebastiaan van Stijn --- compose/completion.md | 2 +- compose/compose-file/compose-file-v2.md | 2 +- compose/compose-file/compose-file-v3.md | 2 +- compose/compose-file/index.md | 2 +- compose/env-file.md | 2 +- compose/extends.md | 2 +- compose/faq.md | 2 +- compose/gettingstarted.md | 2 +- compose/index.md | 2 +- compose/install/index.md | 12 ++++++------ compose/production.md | 2 +- compose/profiles.md | 2 +- compose/reference/envvars.md | 2 +- compose/samples-for-compose.md | 2 +- compose/startup-order.md | 2 +- engine/security/trust/deploying_notary.md | 2 +- engine/security/trust/trust_sandbox.md | 2 +- engine/swarm/stack-deploy.md | 2 +- get-started/08_using_compose.md | 2 +- samples/aspnet-mssql-compose.md | 4 ++-- samples/django.md | 4 ++-- samples/rails.md | 4 ++-- samples/wordpress.md | 4 ++-- 23 files changed, 32 insertions(+), 32 deletions(-) diff --git a/compose/completion.md b/compose/completion.md index c7f1a9908be7..c98941a58a81 100644 --- a/compose/completion.md +++ b/compose/completion.md @@ -127,7 +127,7 @@ Enjoy working with Compose faster and with fewer typos! ## Compose documentation - [User guide](index.md) -- [Installing Compose](install.md) +- [Installing Compose](install/index.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/compose-file/compose-file-v2.md b/compose/compose-file/compose-file-v2.md index 7675a3efd7bb..daf1c2de66a1 100644 --- a/compose/compose-file/compose-file-v2.md +++ b/compose/compose-file/compose-file-v2.md @@ -1979,7 +1979,7 @@ networks: ## Compose documentation - [User guide](../index.md) -- [Installing Compose](../install.md) +- [Installing Compose](../install/index.md) - [Compose file versions and upgrading](compose-versioning.md) - [Sample apps with Compose](../samples-for-compose.md) - [Command line reference](../reference/index.md) diff --git a/compose/compose-file/compose-file-v3.md b/compose/compose-file/compose-file-v3.md index 70939077ef5a..6813d8a86fb6 100644 --- a/compose/compose-file/compose-file-v3.md +++ b/compose/compose-file/compose-file-v3.md @@ -2760,7 +2760,7 @@ stack. ## Compose documentation - [User guide](../index.md) -- [Installing Compose](../install.md) +- [Installing Compose](../install/index.md) - [Compose file versions and upgrading](compose-versioning.md) - [Sample apps with Compose](../samples-for-compose.md) - [Command line reference](../reference/index.md) diff --git a/compose/compose-file/index.md b/compose/compose-file/index.md index 20b5406d2212..0ced54a60f97 100644 --- a/compose/compose-file/index.md +++ b/compose/compose-file/index.md @@ -2501,7 +2501,7 @@ for complex elements, interpolation MUST be applied _before_ merge on a per-file ## Compose documentation - [User guide](../index.md) -- [Installing Compose](../install.md) +- [Installing Compose](../install/index.md) - [Compose file versions and upgrading](compose-versioning.md) - [Sample apps with Compose](../samples-for-compose.md) - [Enabling GPU access with Compose](../gpu-support.md) diff --git a/compose/env-file.md b/compose/env-file.md index 2e44989926eb..382231c38bd0 100644 --- a/compose/env-file.md +++ b/compose/env-file.md @@ -61,7 +61,7 @@ in your Compose file, and can also be used to define the following ## More Compose documentation - [User guide](index.md) -- [Installing Compose](install.md) +- [Installing Compose](install/index.md) - [Getting Started](gettingstarted.md) - [Command line reference](reference/index.md) - [Compose file reference](compose-file/index.md) diff --git a/compose/extends.md b/compose/extends.md index 462453c97e7e..8d5d24c2037b 100644 --- a/compose/extends.md +++ b/compose/extends.md @@ -457,7 +457,7 @@ services: ## Compose documentation - [User guide](index.md) -- [Installing Compose](install.md) +- [Installing Compose](install/index.md) - [Getting Started](gettingstarted.md) - [Command line reference](reference/index.md) - [Compose file reference](compose-file/index.md) diff --git a/compose/faq.md b/compose/faq.md index 899a2203274d..ceac06c225f8 100644 --- a/compose/faq.md +++ b/compose/faq.md @@ -116,7 +116,7 @@ GitHub](https://github.com/search?q=in%3Apath+docker-compose.yml+extension%3Ayml ## Compose documentation - [User guide](index.md) -- [Installing Compose](install.md) +- [Installing Compose](install/index.md) - [Getting Started](gettingstarted.md) - [Command line reference](reference/index.md) - [Compose file reference](compose-file/index.md) diff --git a/compose/gettingstarted.md b/compose/gettingstarted.md index b89538dc31ba..158a804fe660 100644 --- a/compose/gettingstarted.md +++ b/compose/gettingstarted.md @@ -12,7 +12,7 @@ understandable even if you're not familiar with it. ## Prerequisites Make sure you have already installed both [Docker Engine](../get-docker.md) -and [Docker Compose](install.md). You don't need to install Python or Redis, as +and [Docker Compose](install/index.md). You don't need to install Python or Redis, as both are provided by Docker images. ## Step 1: Setup diff --git a/compose/index.md b/compose/index.md index 1f4a18e64603..8120956cf9f3 100644 --- a/compose/index.md +++ b/compose/index.md @@ -76,7 +76,7 @@ Compose has commands for managing the whole lifecycle of your application: If you rely on using Docker Compose as `docker-compose` (with a hyphen), you can set up Compose V2 to act as a drop-in replacement of the previous `docker-compose`. -Refer to the [Installing Compose](install.md) section for detailed instructions. +Refer to the [Installing Compose](install/index.md) section for detailed instructions. ## Context of Docker Compose evolution diff --git a/compose/install/index.md b/compose/install/index.md index 2bad9499d393..747084da088f 100644 --- a/compose/install/index.md +++ b/compose/install/index.md @@ -18,12 +18,12 @@ You can run Compose on macOS, Windows, and 64-bit Linux. Check what installation 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. +[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:__ + __(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/#server){: target="_blank" rel="noopener" class="_"} offered per Linux distro from the Engine install section. + + Using the [convenience scripts](../../engine/install/index.md#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). @@ -32,7 +32,7 @@ Are you looking to: ## Where to go next - [User guide](index.md) -- [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) +- [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) diff --git a/compose/production.md b/compose/production.md index c18c5210451a..60cf20aa677e 100644 --- a/compose/production.md +++ b/compose/production.md @@ -68,7 +68,7 @@ commands work with no further configuration. ## Compose documentation - [User guide](index.md) -- [Installing Compose](install.md) +- [Installing Compose](install/index.md) - [Getting Started](gettingstarted.md) - [Command line reference](reference/index.md) - [Compose file reference](compose-file/index.md) diff --git a/compose/profiles.md b/compose/profiles.md index 0a203924a29c..0e320b225f6a 100644 --- a/compose/profiles.md +++ b/compose/profiles.md @@ -174,7 +174,7 @@ $ COMPOSE_PROFILES=dev docker-compose up phpmyadmin ## Compose documentation - [User guide](index.md) -- [Installing Compose](install.md) +- [Installing Compose](install/index.md) - [Getting Started](gettingstarted.md) - [Command line reference](reference/index.md) - [Compose file reference](compose-file/index.md) diff --git a/compose/reference/envvars.md b/compose/reference/envvars.md index 049a5a6a78c0..bb3eb90e9648 100644 --- a/compose/reference/envvars.md +++ b/compose/reference/envvars.md @@ -141,6 +141,6 @@ python client. ## Related information - [User guide](../index.md) -- [Installing Compose](../install.md) +- [Installing Compose](../install/index.md) - [Compose file reference](../compose-file/index.md) - [Environment file](../env-file.md) diff --git a/compose/samples-for-compose.md b/compose/samples-for-compose.md index bd87fa2c5d44..8ea383e52269 100644 --- a/compose/samples-for-compose.md +++ b/compose/samples-for-compose.md @@ -5,7 +5,7 @@ title: Sample apps with Compose --- The following samples show the various aspects of how to work with Docker -Compose. As a prerequisite, be sure to [install Docker Compose](install.md) +Compose. As a prerequisite, be sure to [install Docker Compose](install/index.md) if you have not already done so. ## Key concepts these samples cover diff --git a/compose/startup-order.md b/compose/startup-order.md index a628f5b3e8aa..131582235493 100644 --- a/compose/startup-order.md +++ b/compose/startup-order.md @@ -89,7 +89,7 @@ script: ## Compose documentation - [User guide](index.md) -- [Installing Compose](install.md) +- [Installing Compose](install/index.md) - [Getting Started](gettingstarted.md) - [Command line reference](reference/index.md) - [Compose file reference](compose-file/index.md) diff --git a/engine/security/trust/deploying_notary.md b/engine/security/trust/deploying_notary.md index b3a6ad3c1366..ccf4531b9290 100644 --- a/engine/security/trust/deploying_notary.md +++ b/engine/security/trust/deploying_notary.md @@ -4,7 +4,7 @@ keywords: trust, security, notary, deployment title: Deploy Notary Server with Compose --- -The easiest way to deploy Notary Server is by using Docker Compose. To follow the procedure on this page, you must have already [installed Docker Compose](../../../compose/install.md). +The easiest way to deploy Notary Server is by using Docker Compose. To follow the procedure on this page, you must have already [installed Docker Compose](../../../compose/install/index.md). 1. Clone the Notary repository. diff --git a/engine/security/trust/trust_sandbox.md b/engine/security/trust/trust_sandbox.md index 37b0cfe3180e..b003303e441b 100644 --- a/engine/security/trust/trust_sandbox.md +++ b/engine/security/trust/trust_sandbox.md @@ -23,7 +23,7 @@ This sandbox requires you to install two Docker tools: Docker Engine >= 1.10.0 and Docker Compose >= 1.6.0. To install the Docker Engine, choose from the [list of supported platforms](../../install/index.md). To install Docker Compose, see the -[detailed instructions here](../../../compose/install.md). +[detailed instructions here](../../../compose/install/index.md). ## What is in the sandbox? diff --git a/engine/swarm/stack-deploy.md b/engine/swarm/stack-deploy.md index 51379e7a6ea9..c3fb32766e59 100644 --- a/engine/swarm/stack-deploy.md +++ b/engine/swarm/stack-deploy.md @@ -27,7 +27,7 @@ To run through this tutorial, you need: > `docker stack` and `docker service` commands must be run from a manager > node. -2. A current version of [Docker Compose](../../compose/install.md). +2. A current version of [Docker Compose](../../compose/install/index.md). ## Set up a Docker registry diff --git a/get-started/08_using_compose.md b/get-started/08_using_compose.md index 048aeb9ae115..5876b66feaf4 100644 --- a/get-started/08_using_compose.md +++ b/get-started/08_using_compose.md @@ -19,7 +19,7 @@ So, how do we get started? If you installed Docker Desktop/Toolbox for either Windows or Mac, you already have Docker Compose! Play-with-Docker instances already have Docker Compose installed as well. If you are on -a Linux machine, you will need to [install Docker Compose](../compose/install.md). +a Linux machine, you will need to [install Docker Compose](../compose/install/index.md). After installation, you should be able to run the following and see version information. diff --git a/samples/aspnet-mssql-compose.md b/samples/aspnet-mssql-compose.md index 3db6c8ca2bea..bf887742f889 100644 --- a/samples/aspnet-mssql-compose.md +++ b/samples/aspnet-mssql-compose.md @@ -12,7 +12,7 @@ Compose to set up and run the sample ASP.NET Core application using the with the [SQL Server on Linux image](https://hub.docker.com/_/microsoft-mssql-server). You just need to have [Docker Engine](../get-docker.md) -and [Docker Compose](../compose/install.md) installed on your +and [Docker Compose](../compose/install/index.md) installed on your platform of choice: Linux, Mac or Windows. For this sample, we create a sample .NET Core Web Application using the @@ -208,7 +208,7 @@ to try out .NET Framework and more SQL Server tutorials. ## More Compose documentation - [Docker Compose overview](../compose/index.md) -- [Install Docker Compose](../compose/install.md) +- [Install Docker Compose](../compose/install/index.md) - [Getting Started with Docker Compose](../compose/gettingstarted.md) - [Docker Compose Command line reference](../compose/reference/index.md) - [Compose file reference](../compose/compose-file/index.md) diff --git a/samples/django.md b/samples/django.md index e34fd8bfbca4..e20b8c37d105 100644 --- a/samples/django.md +++ b/samples/django.md @@ -7,7 +7,7 @@ redirect_from: --- This quick-start guide demonstrates how to use Docker Compose to set up and run a simple Django/PostgreSQL app. Before starting, -[install Compose](../compose/install.md). +[install Compose](../compose/install/index.md). ### Define the project components @@ -286,7 +286,7 @@ In this section, you set up the database connection for Django. ## More Compose documentation - [Docker Compose overview](../compose/index.md) -- [Install Docker Compose](../compose/install.md) +- [Install Docker Compose](../compose/install/index.md) - [Getting Started with Docker Compose](../compose/gettingstarted.md) - [Docker Compose Command line reference](../compose/reference/index.md) - [Compose file reference](../compose/compose-file/index.md) diff --git a/samples/rails.md b/samples/rails.md index 2ccfac77acdc..4aceb5b379cd 100644 --- a/samples/rails.md +++ b/samples/rails.md @@ -7,7 +7,7 @@ redirect_from: --- This Quickstart guide shows you how to use Docker Compose to set up and run -a Rails/PostgreSQL app. Before starting, [install Compose](../compose/install.md). +a Rails/PostgreSQL app. Before starting, [install Compose](../compose/install/index.md). ### Define the project @@ -272,7 +272,7 @@ host. ## More Compose documentation - [Docker Compose overview](../compose/index.md) -- [Install Docker Compose](../compose/install.md) +- [Install Docker Compose](../compose/install/index.md) - [Getting Started with Docker Compose](../compose/gettingstarted.md) - [Docker Compose Command line reference](../compose/reference/index.md) - [Compose file reference](../compose/compose-file/index.md) diff --git a/samples/wordpress.md b/samples/wordpress.md index 7ac51a254ec5..b88e9a743fa0 100644 --- a/samples/wordpress.md +++ b/samples/wordpress.md @@ -9,7 +9,7 @@ redirect_from: You can use Docker Compose to easily run WordPress in an isolated environment built with Docker containers. This quick-start guide demonstrates how to use Compose to set up and run WordPress. Before starting, make sure you have -[Compose installed](../compose/install.md). +[Compose installed](../compose/install/index.md). ### Define the project @@ -144,7 +144,7 @@ network, and the WordPress database. ## More Compose documentation - [Docker Compose overview](../compose/index.md) -- [Install Docker Compose](../compose/install.md) +- [Install Docker Compose](../compose/install/index.md) - [Getting Started with Docker Compose](../compose/gettingstarted.md) - [Docker Compose Command line reference](../compose/reference/index.md) - [Compose file reference](../compose/compose-file/index.md)