update Compose release link, clarified download pattern (#3225)

* update Compose release link, clarified download pattern

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added more version admonitions for Linux and containers, improved notes

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added site-wide variable for Compose version, review comments

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
This commit is contained in:
Victoria Bialas 2017-05-12 14:58:57 -07:00 committed by GitHub
parent 7588f3c852
commit 4dfebb9118
2 changed files with 62 additions and 14 deletions

View File

@ -12,6 +12,7 @@ safe: false
lsi: false
url: https://docs.docker.com
keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13"]
compose_current: 1.13.0
gems:
- jekyll-redirect-from

View File

@ -34,11 +34,21 @@ To install Compose, do the following:
Invoke-WebRequest "https://github.com/docker/compose/releases/download/$dockerComposeVersion/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\docker\docker-compose.exe
```
For example, to download Compose version 1.12.0, the command is:
For example, to download Compose version {{ site.compose_current }}, the command is:
```none
Invoke-WebRequest "https://github.com/docker/compose/releases/download/1.12.0/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_current}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\docker\docker-compose.exe
```
> <span><i class="glyphicon glyphicon-exclamation-sign"></i> 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="_"}.
{: .warning-vanilla}
Now, run the executable to install Compose.
@ -46,16 +56,39 @@ To install Compose, do the following:
[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.
> **Note**: If you get a "Permission denied" error, your `/usr/local/bin` directory
> probably isn't writable and you'll need to install Compose as the superuser. Run
> `sudo -i`, then the two commands below, then `exit`.
> <span><i class="glyphicon glyphicon-ok-sign"></i> Got a "Permission denied" error?
>
If so, your `/usr/local/bin` directory probably isn't writable and
you'll need to install Compose as the superuser. Run `sudo -i`, then
run the download and install commands below, then `exit`.
{: .note-vanilla}
The following is an example command illustrating the format:
Run this command to download Docker Compose, replacing
`$dockerComposeVersion` with the specific version of Compose you want to use:
```bash
curl -L https://github.com/docker/compose/releases/download/1.12.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
curl -L https://github.com/docker/compose/releases/download/$dockerComposeVersion/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
```
For example, to download Compose version {{site.compose_current}}, the command is:
```bash
curl -L https://github.com/docker/compose/releases/download/{{site.compose_current}}/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
```
> <span><i class="glyphicon glyphicon-exclamation-sign"></i> 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. 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="_"}.
{: .warning-vanilla}
If you have problems installing with `curl`, see
[Alternative Install Options](install.md#alternative-install-options).
@ -72,7 +105,7 @@ To install Compose, do the following:
```bash
$ docker-compose --version
docker-compose version 1.12.0, build b31ff33
docker-compose version {{site.compose_current}}, build 1719ceb
```
## Alternative install options
@ -95,18 +128,29 @@ if you are not using virtualenv,
sudo pip install docker-compose
```
> **Note**: pip version 6.0 or greater is required.
> <span><i class="glyphicon glyphicon-ok-sign"></i> pip version 6.0 or greater is required.
### 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:
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:
```bash
$ curl -L --fail https://github.com/docker/compose/releases/download/1.12.0/run.sh > /usr/local/bin/docker-compose
$ curl -L --fail https://github.com/docker/compose/releases/download/{{site.compose_current}}/run.sh > /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
```
> <span><i class="glyphicon glyphicon-exclamation-sign"></i> 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="_"}.
{: .warning-vanilla}
## Master builds
If you're interested in trying out a pre-release build you can download a
@ -153,10 +197,13 @@ To uninstall Docker Compose if you installed using `pip`:
pip uninstall docker-compose
```
> **Note**: If you get a "Permission denied" error using either of the above
> <span><i class="glyphicon glyphicon-ok-sign"></i> 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.
> commands and run again.
{: .note-vanilla}
## Where to go next