From b4d186cba600ffd01517504af7f16adbcc0d6ecd Mon Sep 17 00:00:00 2001
From: Gunjan Sonawane <gunjansonawane462@gmail.com>
Date: Sat, 7 Nov 2026 18:28:28 +0000
Subject: [PATCH] docs: add Windows Docker installation instructions

Signed-off-by: Gunjan Sonawane <gunjansonawane462@gmail.com>
---
 .gitignore                   |  1 +
 docker-compose.windows.yml   | 17 +++++++++++++
 docs/source/installation.rst | 46 ++++++++++++++++++++++++++++++++++++
 3 files changed, 64 insertions(+)
 create mode 100644 docker-compose.windows.yml

diff --git a/.gitignore b/.gitignore
index 63fb1b5b0..06788072e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -68,6 +68,7 @@ bin/
 
 # Environments
 .env
+/vulnerablecode-config/
 .venv
 env/
 venv/
diff --git a/docker-compose.windows.yml b/docker-compose.windows.yml
new file mode 100644
index 000000000..4e249eba1
--- /dev/null
+++ b/docker-compose.windows.yml
@@ -0,0 +1,17 @@
+services:
+  vulnerablecode:
+    volumes:
+      - ./vulnerablecode-config:/etc/vulnerablecode/
+      - static:/var/vulnerablecode/static/
+
+  vulnerablecode_scheduler:
+    volumes:
+      - ./vulnerablecode-config:/etc/vulnerablecode/
+
+  vulnerablecode_rqworker:
+    volumes:
+      - ./vulnerablecode-config:/etc/vulnerablecode/
+
+  vulnerablecode_rqworker_high:
+    volumes:
+      - ./vulnerablecode-config:/etc/vulnerablecode/
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
index 9e9f3c7d1..51da7a98b 100644
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@@ -91,6 +91,51 @@ to run on a different port than 8000.
 
     Set ``STAGING=False`` in ``.env`` file to disable the staging environment warning.
 
+.. _run_with_docker_windows:
+
+Windows installation with Docker
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Windows users should run VulnerableCode with Docker Desktop. Native Windows
+installation is not supported.
+
+Install and start Docker Desktop, then open PowerShell and clone the repository::
+
+    git clone https://github.com/aboutcode-org/vulnerablecode.git
+    cd vulnerablecode
+
+``make envfile`` is not available on Windows. Instead, create a
+``vulnerablecode-config`` directory in the repository root containing a ``.env``
+file with the following content::
+
+    SECRET_KEY="<your-secret-key>"
+    ALTCHA_HMAC_KEY="<your-altcha-hmac-key>"
+
+Replace both placeholder values with your own unique secret values.
+
+The repository's existing ``docker.env`` file supplies the database and Redis
+container settings; keep it in the repository root. The ``vulnerablecode-config``
+directory contains secrets and is ignored by git; do not commit it.
+
+The repository includes ``docker-compose.windows.yml`` to mount this configuration
+directory into the application, scheduler, and RQ worker containers. Start and
+check the services with::
+
+    docker compose -f docker-compose.yml -f docker-compose.windows.yml config --quiet
+    docker compose -f docker-compose.yml -f docker-compose.windows.yml up -d --build
+    docker compose -f docker-compose.yml -f docker-compose.windows.yml ps
+
+Check that all services are running and review their logs if startup fails::
+
+    docker compose -f docker-compose.yml -f docker-compose.windows.yml logs --tail=100
+
+VulnerableCode should then be available at::
+
+    http://localhost
+
+To stop the services::
+
+    docker compose -f docker-compose.yml -f docker-compose.windows.yml down
 
 .. _local_development_installation:
 
@@ -107,6 +152,7 @@ Supported Platforms
 
 .. warning::
      On **Windows** VulnerableCode can **only** :ref:`run_with_docker` and is not supported.
+     See :ref:`run_with_docker_windows`.
 
 Pre-installation Checklist
 ^^^^^^^^^^^^^^^^^^^^^^^^^^