From d0d610720c235fec4dc578c8ffb1142fca6f40c4 Mon Sep 17 00:00:00 2001 From: Madura Herath Date: Fri, 4 Apr 2025 00:05:07 +0530 Subject: [PATCH] docs(platform): Add WSL 2 recommendation for Docker on Windows (#9749) In this pull request, the following changes have been made in response to Issue #9190: Documentation Changes: - Added a note to the AutoGPT documentation regarding Docker installation on Windows. - Specifically, the note advises users to opt for WSL2 (Windows Subsystem for Linux version 2) instead of Hyper-V during Docker setup to prevent issues with Supabase, such as the "unhealthy" status for supabase-db. --------- Co-authored-by: Madura Herath Co-authored-by: Bently --- docs/content/platform/getting-started.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/content/platform/getting-started.md b/docs/content/platform/getting-started.md index 13e7e2cd1a..b8d3a31abc 100644 --- a/docs/content/platform/getting-started.md +++ b/docs/content/platform/getting-started.md @@ -270,6 +270,30 @@ If you run into issues with dangling orphans, try: docker compose down --volumes --remove-orphans && docker-compose up --force-recreate --renew-anon-volumes --remove-orphans ``` +### ๐Ÿ“Œ Windows Installation Note + +When installing Docker on Windows, it is **highly recommended** to select **WSL 2** instead of Hyper-V. Using Hyper-V can cause compatibility issues with Supabase, leading to the `supabase-db` container being marked as **unhealthy**. + +#### **Steps to enable WSL 2 for Docker:** +1. Install [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install). +2. Ensure that your Docker settings use WSL 2 as the default backend: + - Open **Docker Desktop**. + - Navigate to **Settings > General**. + - Check **Use the WSL 2 based engine**. +3. Restart **Docker Desktop**. + +#### **Already Installed Docker with Hyper-V?** +If you initially installed Docker with Hyper-V, you **donโ€™t need to reinstall** it. You can switch to WSL 2 by following these steps: +1. Open **Docker Desktop**. +2. Go to **Settings > General**. +3. Enable **Use the WSL 2 based engine**. +4. Restart Docker. + +๐Ÿšจ **Warning:** Enabling WSL 2 may **erase your existing containers and build history**. If you have important containers, consider backing them up before switching. + +For more details, refer to [Docker's official documentation](https://docs.docker.com/desktop/windows/wsl/). + + ## Development ### Formatting & Linting