Fixing broken links

Formatting improvements along the way
This commit is contained in:
Misty Stanley-Jones
2017-01-24 14:21:10 -08:00
parent 74e52a5f16
commit ef95a915eb
40 changed files with 924 additions and 642 deletions

View File

@@ -8,46 +8,54 @@ You can run Compose on macOS, Windows and 64-bit Linux. To install it, you'll ne
To install Compose, do the following:
1. Install Docker Engine:
1. Install Docker Engine:
* <a href="/engine/installation/mac/" target="_blank">macOS installation</a>
* [macOS installation](/docker-for-mac/index.md){: target="_blank" class="_"}
* <a href="/engine/installation/windows/" target="_blank">Windows installation</a>
* [Windows installation](/docker-for-windows/index.md){: target="_blank" class="_"}
* <a href="/engine/installation/linux/ubuntulinux/" target="_blank">Ubuntu installation</a>
* [Ubuntu installation](/engine/installation/linux/ubuntu.md){: target="_blank" class="_"}
* <a href="/engine/installation/" target="_blank">other system installations</a>
* [Other systems](/engine/installation/index.md){: target="_blank" class="_"}
2. The Docker Toolbox installation includes both Engine and Compose, so Mac and Windows users are done installing. Others should continue to the next step.
2. The Docker Toolbox installation includes both Engine and Compose, so Mac and
Windows users are done installing. Others should continue to the next step.
3. Go to the <a href="https://github.com/docker/compose/releases" target="_blank">Compose repository release page on GitHub</a>.
3. Go to the
[Compose repository release page on GitHub](https://github.com/docker/compose/releases){: target="_blank" class="_"}.
4. Follow the instructions from the release page and run the `curl` command,
which the release page specifies, in your terminal.
4. Follow the instructions from the release page and run the `curl` command,
which the release page specifies, in your terminal.
> 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`.
> 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`.
The following is an example command illustrating the format:
The following is an example command illustrating the format:
$ curl -L "https://github.com/docker/compose/releases/download/1.10.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
```bash
$ curl -L "https://github.com/docker/compose/releases/download/1.10.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
```
If you have problems installing with `curl`, see
[Alternative Install Options](install.md#alternative-install-options).
If you have problems installing with `curl`, see
[Alternative Install Options](install.md#alternative-install-options).
5. Apply executable permissions to the binary:
5. Apply executable permissions to the binary:
chmod +x /usr/local/bin/docker-compose
```bash
$ chmod +x /usr/local/bin/docker-compose
```
6. Optionally, install [command completion](completion.md) for the
`bash` and `zsh` shell.
`bash` and `zsh` shell.
7. Test the installation.
7. Test the installation.
$ docker-compose --version
docker-compose version: 1.10.0
```bash
$ docker-compose --version
docker-compose version: 1.10.0
```
## Alternative install options
@@ -60,7 +68,9 @@ have python system packages that conflict with docker-compose dependencies. See
the [virtualenv tutorial](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
to get started.
pip install docker-compose
```bash
$ pip install docker-compose
```
> **Note:** pip version 6.0 or greater is required
@@ -69,15 +79,18 @@ to get started.
Compose can also be run inside a container, from a small bash script wrapper.
To install compose as a container run:
$ curl -L https://github.com/docker/compose/releases/download/1.10.0/run.sh > /usr/local/bin/docker-compose
$ chmod +x /usr/local/bin/docker-compose
```bash
$ curl -L https://github.com/docker/compose/releases/download/1.10.0/run.sh > /usr/local/bin/docker-compose
$ chmod +x /usr/local/bin/docker-compose
```
## 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.
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
@@ -92,27 +105,35 @@ to run so that you don't end up with two sets of them. If you want to keep using
your existing containers (for example, because they have data volumes you want
to preserve) you can use compose 1.5.x to migrate them with the following command:
docker-compose migrate-to-labels
```bash
$ docker-compose migrate-to-labels
```
Alternatively, if you're not worried about keeping them, you can remove them.
Compose will just create new ones.
docker rm -f -v myapp_web_1 myapp_db_1 ...
```bash
docker rm -f -v myapp_web_1 myapp_db_1 ...
```
## Uninstallation
To uninstall Docker Compose if you installed using `curl`:
rm /usr/local/bin/docker-compose
```bash
rm /usr/local/bin/docker-compose
```
To uninstall Docker Compose if you installed using `pip`:
pip uninstall docker-compose
```bash
$ pip uninstall docker-compose
```
>**Note**: 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.
> **Note**: 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
@@ -122,5 +143,5 @@ To uninstall Docker Compose if you installed using `pip`:
- [Get started with Django](django.md)
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Command line reference](/compose/reference/index.md)
- [Compose file reference](compose-file.md)