How to Set Up Docker for Sitecore Development

Hello, Sitecore enthusiasts out there!👋😊 In today's blog, I'll walk you through the entire process of setting up Docker for Sitecore development. So, grab a cup of coffee, and let's get started!

Why Docker for Sitecore? 🐳

Before we dive into the technicalities, let's talk about why you'd want to use Docker for Sitecore development. Docker offers a range of benefits, including: 

• Isolation: Each container is isolated, ensuring that your application behaves the same way, regardless of where it's running. 
• Scalability: Docker containers can be easily scaled up or down, providing flexibility in development and deployment. 
• Consistency: Say goodbye to the "it works on my machine" problem. With Docker, if it works on one machine, it will work on all.

Prerequisites : What You'll Need 

• Operating System: Windows 10 Professional or Enterprise (version 1903 or later) 
• Virtualization: Hyper-V enabled 
• Hardware: At least 16GB RAM, a quad-core CPU, and 25GB of free disk space

Pre-Installation Steps 

• Enable Hyper-V: Go to Control Panel > Programs > Turn Windows features on or off > Enable Hyper-V. 

• Update Windows: Make sure your OS is up-to-date to avoid any compatibility issues.

Installing Docker

Download Docker Desktop

1. Head over to the Docker Desktop for Windows website and download the installer. 
   
   
   
2. Run the installer and follow the on-screen instructions. 

Choose Your Container Type

During the installation, you'll be prompted to choose between Linux and Windows containers. Opt for Windows containers to align with Sitecore's requirements.

Configuring Docker for Sitecore

Start Docker Desktop

1. Once installed, start Docker Desktop.
2. Look for the Docker whale icon in the system tray. A steady icon indicates Docker is ready.

Switch to Windows Containers

1. Right-click on the Docker whale icon in the system tray.
2. Select the option to switch to Windows containers. (I have already enabled this option, see in below screenshot)
   

Running Your Sitecore Instance

Clone Sitecore Docker Images

1. Open your command prompt and navigate to your desired directory.
2. Run git clone docker-examples- git repo
3. I will download the updated docker compose file for my setup. So, Go to -> Update release of SXP Sitecore Container Deployment 10.3 then download the zip file and unzip the file.

Preparing the Environment 

• Navigate to Sitecore Docker Examples: Open a command prompt and navigate to the directory where you cloned the Sitecore Docker examples.
• Run Initialization Script: Execute the initialization script by running '.\init.ps1'.

• Fixing PowerShell Script Error: If you encounter an error message related to PowerShell script execution, it could be due to the execution policy and script signing settings on your system. PowerShell's "Execution Policy" determines which scripts are allowed to run. The error message indicates that the script "init.ps1" cannot be executed due to missing digital signing and the current execution policy.

If you face PowerShell script errors due to execution policy, use these steps: 

• Temporarily Adjust Policy: Open PowerShell as admin and run Set-ExecutionPolicy Bypass. But remember, this can pose security risks, so reset it after.
• Unblock Script: If the script is blocked (from the internet), unblock it with Unblock-File in PowerShell.
• Advanced Option: Sign Script: Enhance security by digitally signing the script with a certificate, best for advanced users. Be careful with scripts, verify sources, and prioritize security while troubleshooting.

Configuration Changes

1. Copy Relevant Files: Copy the docker-compose.yml and .env files from the ltsc2022/xp0 (or whichever configuration you're using) folder of the unzipped SitecoreContainerDeployment.10.3.1.009452.1448 into your Sitecore Docker examples directory.
2. Edit .env File: Open the .env file and update the environment variables like SITECORE_LICENSE, SQL_SA_PASSWORD, etc., according to your setup.

Running Sitecore

Navigate to Directory

• Open Command Prompt: Press Windows + X and select "Windows Terminal (Admin)" to open a command prompt with administrative privileges. 
• Navigate to Directory: Use the cd command to navigate to the directory where your updated docker-compose.yml file is located. For example, if it's in a folder named SitecoreDocker on your C: drive, you'd type cd C:\SitecoreDocker.

Build and Start Containers 

• Run Docker Compose: Type docker-compose up -d and press Enter. This command will start reading the docker-compose.yml file and begin pulling the necessary images if they are not already downloaded. 
• Docker will then build the images. This involves executing all the commands in the Dockerfile for each service defined in docker-compose.yml.
• After building, Docker will start the containers in detached mode (-d flag).
• Monitor Progress: You'll see a lot of text scrolling as Docker pulls the necessary images and starts the containers. Wait until the process is complete.

Possible Errors and Solutions

• Port Already in Use: If you see an error like Bind for 0.0.0.0:44001 failed: port is already allocated, it means the port specified is already in use. You'll need to either stop the service using that port or update the docker-compose.yml file to use a different port.
• Insufficient Memory: Docker might throw errors if there's not enough memory available. Make sure you meet the hardware prerequisites, especially the RAM.
• Docker Not Running: If you get an error that says Docker is not running, make sure the Docker Desktop application is running. You can start it from the Start menu.
• Environment Variables Not Set: If you forgot to set the environment variables in the .env file, you'll likely get errors during the docker-compose up -d step. Make sure to fill in all required variables like SITECORE_LICENSE and SQL_SA_PASSWORD.

Verifying the Setup

• Access Sitecore: Open a web browser and navigate to http://localhost:44001. Log in using the default credentials (admin/b).
• Check CM and CD Sites: Navigate to http://cm.sitecore.local for the Content Management site and http://cd.sitecore.local for the Content Delivery site.

Possible Errors and Solutions

• Site Not Accessible: If you can't access the Sitecore, CM, or CD sites, make sure your hosts file (C:\Windows\System32\drivers\etc\hosts) has the necessary entries for cm.sitecore.local and cd.sitecore.local.
• Login Issues: If you can't log in, double-check that you're using the correct default credentials. If you've changed the password in the .env file, use that password instead.

Note for Users: Ensuring Compatibility of Docker Images with Windows Versions 

When working with Docker images on Windows systems, it's crucial to consider the compatibility between the Docker images and your Windows version. Docker images are designed to run in specific operating system environments, and modifying their compatibility can be intricate and potentially lead to issues. Here are some essential points to keep in mind:

• Check Image Compatibility: Always verify if the Docker images you intend to use are compatible with your Windows version (e.g., Windows 10.0.20xx). This information is typically provided by image maintainers or repositories.
• Upgrade Wisely: While upgrading your Windows version might align better with Docker images, it's essential to evaluate the feasibility and implications, especially in production or enterprise settings.
• Avoid Image Modification: Attempting to modify Docker images to suit an older Windows version is complex and may lead to instability and security risks. Docker images are designed to provide consistent and secure environments.

In conclusion, ensuring compatibility between Docker images and Windows versions is crucial for a smooth and secure experience. It's recommended to work within the existing compatibility parameters or explore alternative solutions in case of incompatibility.

Final Thoughts💭

Thank you for joining me on this detailed walkthrough. Whether you're a seasoned developer or just starting your journey, understanding how to navigate complex development environments like Sitecore with Docker is an invaluable skill. I hope this guide has been a useful resource, providing clarity and solutions to common challenges you may face. Here's to your continued success in all your development endeavors!😊