Skip to content

[Docs] docker: Add troubleshooting guide #67

@Ahmed3abbas

Description

@Ahmed3abbas

🐳 Problem Statement

The current README has Docker setup instructions:
docker-compose up --build

However, new contributors frequently face
platform-specific issues not covered anywhere:

Windows Issues:

  • WSL2 not configured properly
  • Docker Desktop not running
  • Port conflicts on 8000/5173/6379
  • Line ending (CRLF vs LF) errors
  • Volume mount permission issues

Mac Issues:

  • Apple Silicon (M1/M2/M3) compatibility
  • Rosetta 2 requirements for some images
  • File system performance with volumes
  • Redis connection issues on macOS

🎯 Proposed Solution

Add a DOCKER_TROUBLESHOOTING.md file covering:

Windows Setup:

  • WSL2 installation & configuration
  • Docker Desktop settings for WSL2
  • Common error messages + fixes
  • Port conflict resolution commands

Mac Setup:

  • Apple Silicon compatibility notes
  • Docker Desktop memory allocation
  • Common permission fixes

Common Issues (All Platforms):

  • Redis connection refused → fix
  • Database migration failures → fix
  • Frontend not hot-reloading → fix
  • Container build failures → fix
  • Environment variable not found → fix

Quick Diagnostic Commands:

# Check all containers running
docker-compose ps

# View logs for specific service  
docker-compose logs backend
docker-compose logs frontend
docker-compose logs redis

# Reset everything
docker-compose down -v
docker-compose up --build

📁 Files to Add/Modify

  • Add: DOCKER_TROUBLESHOOTING.md
  • Update: README.md (link to new guide)

✅ Acceptance Criteria

  • Windows WSL2 setup guide included
  • Mac Apple Silicon notes included
  • Common errors documented with fixes
  • Diagnostic commands provided
  • README links to the new guide
  • Tested on at least one platform

💡 Why This Matters

Docker setup is the #1 blocker for new
GSSoC contributors. A troubleshooting guide
will unblock dozens of contributors instantly.

🙋 About Me

GSSoC 2026 Contributor — AI/Agents Track
Certifications: Docker & Kubernetes (Scaler)
Experience: Docker containers, volumes,
Docker Compose, cloud deployments

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions