This document applies to development environments running Windows 10, which uses Docker Desktop.
To run Docker on Windows 10, you will need the following:
- Windows 10 Professional or Enterprise version 1809 (2019 LTSC) or later. For enabling process isolation, version 1909 is recommended.
- Hyper-V enabled.
The Docker Desktop installer will also enable Hyper-V if necessary, but a machine restart will be required during install.
Note for VirtualBox users: When Hyper-V is enabled, VirtualBox will no longer work. However, any existing VirtualBox VM images are retained.
Hardware must first meet the requirements for running Hyper-V itself. For complete details, including how to verify compatibility, see Windows 10 Hyper-V System Requirements. To summarize, Hyper-V requires:
- 64 bit processor with Second-level address translation (SLAT) and hardware-assisted virtualization.
- At least 4GB of RAM (See below for Sitecore guidelines).
- Virtualization support turned on in the BIOS.
In addition to the Hyper-V requirements above, these are the hardware recommendations for Sitecore development:
- 16GB of RAM (minimum), 32GB of RAM (recommended). This will depend on the number of instances and which topologies you plan to run (i.e. the number of simultaneously running containers). For example, 16GB may be sufficient for XM1 or XP0 instances, but you'll likely experience issues running a full XP1 instance.
- A quad core or higher CPU.
- Approximately 25GB of free disk space for Sitecore container images. SSD storage is highly recommended for optimal performance when downloading and running Docker containers.
Once prerequisites are met, the installation itself is quite simple.
Install Docker Desktop
- Download Docker Desktop for Windows and run the installer.
- During installation, choose to use Windows containers instead of Linux containers. You can also switch to Windows containers after the install (see below).
Alternatively, install using Chocolatey with the following command:
choco install docker-desktop
For more details, see the Docker documentation.
Start Docker Desktop
Docker Desktop does not automatically start after installation. If you have not already done so, start Docker Desktop.
When the Docker item (whale icon) in the Windows system tray stays steady, Docker Desktop is up and ready to go.
Note Docker Desktop is configured to run automatically on log in, so you shouldn't typically have to launch it manually.
Switch to Windows containers
We'll be doing our Sitecore development using Windows-based containers. If you did not choose Windows containers during the installation, you'll need to do that now.
You can switch using the Docker item (whale icon) in the Windows system tray (as shown below).
docker version from a command prompt to check the basic details of your installation. You should see "windows" listed as the operating system for the Docker client and the Docker server:
PS C:\WINDOWS\system32> docker version Client: Docker Engine - Community Version: 19.03.8 API version: 1.40 Go version: go1.12.17 Git commit: afacb8b Built: Wed Mar 11 01:23:10 2020 OS/Arch: windows/amd64 Experimental: false Server: Docker Engine - Community Engine: Version: 19.03.8 API version: 1.40 (minimum version 1.24) Go version: go1.12.17 Git commit: afacb8b Built: Wed Mar 11 01:37:20 2020 OS/Arch: windows/amd64 Experimental: false
Now that your environment has been configured correctly, follow the link to learn how to run your first container-based Sitecore instance.