Skip to content

Latest commit

 

History

History
252 lines (194 loc) · 9.18 KB

install.md

File metadata and controls

252 lines (194 loc) · 9.18 KB
Raw
description keywords title toc_max
How to install Docker Compose
compose, orchestration, install, installation, docker, documentation
Install Docker Compose
2

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 for Mac and Windows, Docker Compose is included as part of those desktop installs.

  • On Linux systems, first install the Docker{: target="blank" class=""} for your OS as described on the Get Docker page, then come back here for instructions on installing Compose on Linux systems.

  • To run Compose as a non-root user, see Manage Docker as a non-root user.

Install Compose

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.

  • Mac
  • Windows
  • Linux
  • Alternative Install Options
### Install Compose on macOS

Docker for Mac and Docker Toolbox already include Compose along with other Docker apps, so Mac users do not need to install Compose separately. Docker install instructions for these are here:

### Install Compose on Windows systems

Docker for Windows and Docker Toolbox already include Compose along with other Docker apps, so most Windows users do not need to install Compose separately. Docker install instructions for these are here:

If you are running the Docker daemon and client directly on Microsoft Windows Server 2016 (with Docker EE for Windows Server 2016, you do need to install Docker Compose. To do so, follow these steps:

  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.

    In PowerShell, run the following command to download Docker Compose, replacing $dockerComposeVersion with the specific version of Compose you want to use:

    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 {{site.compose_version}}, the command is:

    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

    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{:target="blank" class=""}. {: .important}

  2. Run the executable to install Compose.

### Install Compose on Linux systems

On Linux, you can download the Docker Compose binary from the Compose repository release page on GitHub{: 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:

    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{: target="blank" class=""}. {: .important}

    If you have problems installing with curl, see Alternative Install Options tab above.

  2. Apply executable permissions to the binary:

    sudo chmod +x /usr/local/bin/docker-compose

  3. Optionally, install command completion for the bash and zsh shell.

  4. Test the installation.

    $ docker-compose --version
docker-compose version {{site.compose_version}}, build 1719ceb
### Alternative install options

Install using pip

Compose can be installed from pypi using pip. If you install using pip, we recommend that you use a virtualenv because many operating systems have python system packages that conflict with docker-compose dependencies. See the virtualenv tutorial to get started.

pip install docker-compose

If you are not using virtualenv,

sudo pip install docker-compose

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 this command. Be sure to replace the version number with the one that you want, if this example is out-of-date:

$ 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{: target="blank" class=""}. {: .important}

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/. Pre-release builds allow you to try out new features before they are released, but may be less stable.

Upgrading

If you're upgrading from Compose 1.2 or earlier, remove or migrate your existing containers after upgrading Compose. This is because, as of version 1.3, Compose uses Docker labels to keep track of containers, and your containers need to be recreated to add the labels.

If Compose detects containers that were created without labels, it refuses 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

Alternatively, if you're not worried about keeping them, you can remove them. Compose just creates new ones.

docker container rm -f -v myapp_web_1 myapp_db_1 ...

Uninstallation

To uninstall Docker Compose if you installed using curl:

sudo rm /usr/local/bin/docker-compose

To uninstall Docker Compose if you installed using pip:

pip uninstall 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