Installation

Prerequisites

WP Local Docker requires docker, docker-compose, Node, and npm. It is recommended that you use the latest versions of docker and docker-compose. Node 10 (current LTS version) is the only version of node that is supported. While WP Local Docker may work with other versions of Node, compatibility is not guaranteed.

MacOS

Docker Desktop is available for download from the Docker website and will install docker-compose automatically. NodeJS and npm can be installed from the NodeJS website, via a package manager, such as Homebrew, or using a version manager, such as nvm.

NodeJS EACCESS Error

If Node was installed via the download from the NodeJS website, you will likely get an EACCESS error when trying to install global npm packages without using sudo. Npm has an article on preventing permission errors if you’d like to run the command without sudo. Alternatively, just run the install command with sudo.

Windows

Docker Desktop is available for download from the Docker website and will install docker-compose automatically. NodeJS and npm can be installed from the NodeJS website.

Linux

Docker has platform specific installation instructions available for linux on their documentation site. Once docker is installed, you will need to manually install docker compose. NodeJS can be installed via a package manager for many linux platforms following these instructions.

Installation

Once all installation prerequisites have been met, WP Local Docker is installed as a global npm package by running npm install -g wp-local-docker. You can confirm it has been installed by running 10updocker --version.

Configuration

The first time you run a WP Local Docker command, default configuration settings will be used if you have not manually configured WP Local Docker beforehand. By default, WP Local Docker will store all environments within the ~/wp-local-docker-sites directory and try to manage your hosts file when creating and deleting environments. If you would like to customize the environment path or opt to not have WP Local Docker update your hosts file, run 10updocker configure and follow the prompts.

Updating

To update WP Local Docker, run npm update -g wp-local-docker