From 14c0e9f0da270c79da508bf20bafe34937cf8b25 Mon Sep 17 00:00:00 2001 From: "Donald F. Coffin" Date: Wed, 20 May 2026 01:15:30 -0400 Subject: [PATCH] docs: broaden Docker prerequisites to cover WSL2 and non-Desktop setups MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The previous "Docker Desktop installed and running" line excluded forkers running Docker Engine in WSL2, native Linux Docker, or Rancher Desktop / Podman. Since TestContainers auto-detects whatever daemon is reachable, the project supports all of them — the README just needed to say so. Also adds a troubleshooting note for the daemon.json + systemd -H fd:// hosts-conflict trap that bites pure-WSL Docker installs. Co-Authored-By: Claude Opus 4.7 --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 00fa0dc4..a28824df 100644 --- a/README.md +++ b/README.md @@ -128,13 +128,19 @@ mvn test -pl openespi-common ### Integration Tests with TestContainers **Prerequisites:** -- Docker Desktop installed and running +- A reachable Docker daemon (any of the following works): + - Docker Desktop on Windows (WSL2 backend) or macOS + - Docker Engine in WSL2 (without Docker Desktop) + - Docker Engine native on Linux + - Rancher Desktop or Podman with Docker socket compatibility - Minimum 4GB RAM allocated to Docker -- Ports 3306 (MySQL) and 5432 (PostgreSQL) available +- TestContainers auto-detects the Docker socket — no project configuration required + +> **Note for WSL2 users running Docker Engine without Docker Desktop:** make sure the daemon is running (`sudo systemctl start docker`) and your user is in the `docker` group (`sudo usermod -aG docker $USER`, then re-login). If `dockerd` fails to start, check `/etc/docker/daemon.json` for a `hosts` entry that conflicts with the systemd unit's `-H fd://` flag. **Quick Start:** ```bash -# Verify Docker is running +# Verify Docker is reachable (any setup above) docker --version && docker ps # Run all integration tests (H2, MySQL, PostgreSQL)