docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify that compose installation is for stable release 

This patch updates the compose installation instruction to
be more clear about the default instructions installing
the current stable release.

Inline nodes about installing different versions has been
reduced, and the "Master builds" section has been renamed
to "Install pre-release builds", to capture installing either
"master" builds, or pre-releases (release-candidates) from
GitHub.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2019-03-06 13:21:54 +01:00
parent 8a1b16e8e0
commit f6ed1b7725
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
1 changed files with 53 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
compose/install.md
View File

@ -29,6 +29,16 @@ Follow the instructions below to install Compose on Mac, Windows, Windows Server
2016, or Linux systems, or find out about alternatives like using the `pip`
Python package manager or installing Compose as a container.
> Install a different version
>
> The instructions below outline installation of the current stable release
> (**v{{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" class="_"}.
> To install a **pre-release** of Compose, refer to the [install pre-release builds](#install-pre-release-builds)
> section.
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" data-target="#macOS">Mac</a></li>
<li><a data-toggle="tab" data-target="#windows">Windows</a></li>
@ -37,6 +47,7 @@ Python package manager or installing Compose as a container.
</ul>
<div class="tab-content">
<div id="macOS" class="tab-pane fade in active" markdown="1">
### Install Compose on macOS
**Docker Desktop for Mac** and **Docker Toolbox** already include Compose along
@ -45,9 +56,10 @@ Docker install instructions for these are here:
* [Get Docker Desktop for Mac](/docker-for-mac/install.md)
* [Get Docker Toolbox](/toolbox/overview.md) (for older systems)
<hr>
</div>
<div id="windows" class="tab-pane fade" markdown="1">
### Install Compose on Windows systems
**Docker Desktop for Windows** and **Docker Toolbox** already include Compose
@ -66,59 +78,49 @@ Docker Compose. To do so, follow these steps:
**Run as administrator**. When asked if you want to allow this app
to make changes to your device, click **Yes**.
In Powershell, since Github now requires TLS1.2, run the following:
In PowerShell, since Github now requires TLS1.2, run the following:
```none
```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
```
Then run the following command to download
Docker Compose, replacing `$dockerComposeVersion` with the specific
version of Compose you want to use:
Then run the following command to download the current stable release of
Compose (v{{site.compose_version}}):
```none
Invoke-WebRequest "https://github.com/docker/compose/releases/download/$dockerComposeVersion/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\Docker\resources\bin\docker-compose.exe
```
For example, to download Compose version {{site.compose_version}},
the command is:
```none
```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\resources\bin\docker-compose.exe
```
> Use the latest Compose release number in the download command.
>
> As already mentioned, the above command is an _example_, and
it may become out-of-date once in a while. Always follow the
command pattern shown above it. If you cut-and-paste an example,
check which release it specifies and, if needed,
replace `$dockerComposeVersion` with the release number that
you want. Compose releases are also available for direct download
on the [Compose repository release page on GitHub](https://github.com/docker/compose/releases){:target="_blank" class="_"}.
{: .important}
2. Run the executable to install Compose.
<hr>
> To install a different version of Compose, substitute `{{site.compose_version}}`
> with the version of Compose you want to use.
2. Test the installation.
```powershell
docker-compose --version
docker-compose version {{site.compose_version}}, build 01110ad01
```
</div>
<div id="linux" class="tab-pane fade" markdown="1">
### Install Compose on Linux systems
On **Linux**, you can download the Docker Compose binary from the [Compose
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" class="_"}. 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 latest version of Docker Compose:
1. Run this command to download the current stable release of Docker Compose:
```bash
sudo curl -L "https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
```
> Use the latest Compose release number in the download command.
>
The above command is an _example_, and it may become out-of-date. To ensure you have the latest version, check the [Compose repository release page on GitHub](https://github.com/docker/compose/releases){: target="_blank" class="_"}.
{: .important}
> To install a different version of Compose, substitute `{{site.compose_version}}`
> with the version of Compose you want to use.
If you have problems installing with `curl`, see
[Alternative Install Options](install.md#alternative-install-options) tab above.
@ -147,9 +149,9 @@ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
$ docker-compose --version
docker-compose version {{site.compose_version}}, build 1110ad01
```
<hr>
</div>
<div id="alternatives" class="tab-pane fade" markdown="1">
### Alternative install options
- [Install using pip](#install-using-pip)
@ -180,34 +182,31 @@ sudo pip install docker-compose
#### Install as a container
Compose can also be run inside a container, from a small bash script wrapper. To
install compose as a container run this command. Be sure to replace the version
number with the one that you want, if this example is out-of-date:
install compose as a container run this command:
```bash
$ sudo curl -L --fail https://github.com/docker/compose/releases/download/{{site.compose_version}}/run.sh -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
```
> Use the latest Compose release number in the download command.
>
The above command is an _example_, and it may become out-of-date once in a
while. Check which release it specifies and, if needed, 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"
class="_"}.
</div>
</div>
----
## Install pre-release builds
If you're interested in trying out a pre-release build, you can download release
candidates from the [Compose repository release page on GitHub](https://github.com/docker/compose/releases){: target="_blank" class="_"}.
Follow the instructions from the link, which involves running the `curl` command
in your terminal to download the binaries.
Pre-releases built from the "master" branch are also available for download at
[https://dl.bintray.com/docker-compose/master/](https://dl.bintray.com/docker-compose/master/){: target="_blank" class="_"}.
> Pre-release builds allow you to try out new features before they are released,
> but may be less stable.
{: .important}
<hr>
</div>
</div>
## Master builds
If you're interested in trying out a pre-release build, you can download a binary
from
[https://dl.bintray.com/docker-compose/master/](https://dl.bintray.com/docker-compose/master/).
Pre-release builds allow you to try out new features before they are released,
but may be less stable.
## Upgrading