From 5a1815fafed46524d8d89a1a05bf17c94d5b5bcf Mon Sep 17 00:00:00 2001
From: openhands <openhands@all-hands.dev>
Date: Thu, 4 Jun 2026 16:27:22 +0000
Subject: [PATCH] docs: add Windows (PowerShell) instructions for Agent Canvas
 Docker setup

Add Windows-specific Docker commands to both the main setup page and the
Docker backend setup page. The commands use PowerShell syntax (backtick
line continuation, $env:USERPROFILE paths, New-Item for directory creation)
matching the upstream README.windows.md from agent-canvas.

Co-authored-by: openhands <openhands@all-hands.dev>
---
 .../agent-canvas/backend-setup/docker.mdx     | 41 ++++++++++++++-----
 openhands/usage/agent-canvas/setup.mdx        | 24 ++++++++++-
 2 files changed, 53 insertions(+), 12 deletions(-)

diff --git a/openhands/usage/agent-canvas/backend-setup/docker.mdx b/openhands/usage/agent-canvas/backend-setup/docker.mdx
index 8e8633fa..7e72170d 100644
--- a/openhands/usage/agent-canvas/backend-setup/docker.mdx
+++ b/openhands/usage/agent-canvas/backend-setup/docker.mdx
@@ -7,20 +7,41 @@ The official Docker image packages the full Agent Canvas stack — backend and f
 
 ## Prerequisites
 
-- [Docker](https://docs.docker.com/get-docker/) installed and running
+- [Docker](https://docs.docker.com/get-docker/) installed and running (Docker Desktop on macOS/Windows, or Docker Engine on Linux)
 - Agent Canvas installed locally (if connecting from another instance) — see [Setup](/openhands/usage/agent-canvas/setup)
 
 ## Run the Official Image
 
-Mount a persistence directory for settings, secrets, and conversation history, and a projects directory for workspace access:
-
-```bash
-docker run -it --rm \
-  -p 8000:8000 \
-  -v ~/.openhands:/home/openhands/.openhands \
-  -v ~/projects:/projects \
-  ghcr.io/openhands/agent-canvas:latest
-```
+Mount a persistence directory for settings, secrets, and conversation history, and a projects directory for workspace access.
+
+<Tabs>
+  <Tab title="macOS / Linux">
+    ```bash
+    mkdir -p ~/projects ~/.openhands
+
+    docker run -it --rm \
+      -p 8000:8000 \
+      -v ~/.openhands:/home/openhands/.openhands \
+      -v ~/projects:/projects \
+      ghcr.io/openhands/agent-canvas:latest
+    ```
+  </Tab>
+  <Tab title="Windows (PowerShell)">
+    ```powershell
+    New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.openhands", "$env:USERPROFILE\projects" | Out-Null
+
+    docker run -it --rm `
+      -p 8000:8000 `
+      -v "$($env:USERPROFILE)\.openhands:/home/openhands/.openhands" `
+      -v "$($env:USERPROFILE)\projects:/projects" `
+      ghcr.io/openhands/agent-canvas:latest
+    ```
+
+    <Note>
+      Docker Desktop for Windows must be installed and running. PowerShell uses backticks (`` ` ``) for line continuation instead of backslashes.
+    </Note>
+  </Tab>
+</Tabs>
 
 Agent Canvas is now running at `http://localhost:8000`. The agent can access any project under the mounted `/projects` path.
 
diff --git a/openhands/usage/agent-canvas/setup.mdx b/openhands/usage/agent-canvas/setup.mdx
index 819ff8c8..f86ecfdc 100644
--- a/openhands/usage/agent-canvas/setup.mdx
+++ b/openhands/usage/agent-canvas/setup.mdx
@@ -44,11 +44,16 @@ description: Install and run Agent Canvas via npm or Docker.
     | `OH_AGENT_SERVER_VERSION` | Pin a specific agent server version (e.g. `0.1.0`) |
   </Tab>
   <Tab title="Docker">
-    **Prerequisites:** [Docker](https://docs.docker.com/get-docker/).
+    **Prerequisites:** [Docker](https://docs.docker.com/get-docker/) (Docker Desktop on macOS/Windows, or Docker Engine on Linux).
 
-    A Docker image is available that sandboxes the entire Agent Canvas stack. Mount your project files and a persistence directory for settings, secrets, and conversation history:
+    A Docker image is available that sandboxes the entire Agent Canvas stack. Mount your project files and a persistence directory for settings, secrets, and conversation history.
 
+    Create a host directory for your projects (the agent can access any folder under this path) and run the container:
+
+    **macOS / Linux:**
     ```bash
+    mkdir -p ~/projects ~/.openhands
+
     docker run -it --rm \
       -p 8000:8000 \
       -v ~/.openhands:/home/openhands/.openhands \
@@ -56,6 +61,21 @@ description: Install and run Agent Canvas via npm or Docker.
       ghcr.io/openhands/agent-canvas:latest
     ```
 
+    **Windows (PowerShell):**
+    ```powershell
+    New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.openhands", "$env:USERPROFILE\projects" | Out-Null
+
+    docker run -it --rm `
+      -p 8000:8000 `
+      -v "$($env:USERPROFILE)\.openhands:/home/openhands/.openhands" `
+      -v "$($env:USERPROFILE)\projects:/projects" `
+      ghcr.io/openhands/agent-canvas:latest
+    ```
+
+    <Note>
+      On Windows, Docker Desktop must be installed and running. PowerShell uses backticks (`` ` ``) for line continuation instead of backslashes.
+    </Note>
+
     ### Environment Variables
 
     Configuration is passed via `-e` flags on `docker run`: