Repository navigation
docs: add Windows Docker installation instructions - #2427
Open
gunjansonaw wants to merge 1 commit into
Open
gunjansonaw wants to merge 1 commit into
gunjansonaw wants to merge 1 commit into
Conversation
gunjansonaw
force-pushed
the
docs/windows-docker-setup
branch
from
September 2, 2026 16:36
f3cddd8 to
991e20c
Compare
ziadhany
requested changes
Oct 6, 2026
Comment on lines
+123
to
+138
| Create ``docker-compose.override.yml`` with the configuration mount for the | ||
| application, scheduler, and both RQ workers:: | ||
|
|
||
| services: | ||
| vulnerablecode: | ||
| volumes: | ||
| - .\vulnerablecode-config:/etc/vulnerablecode/ | ||
| vulnerablecode_scheduler: | ||
| volumes: | ||
| - .\vulnerablecode-config:/etc/vulnerablecode/ | ||
| vulnerablecode_rqworker: | ||
| volumes: | ||
| - .\vulnerablecode-config:/etc/vulnerablecode/ | ||
| vulnerablecode_rqworker_high: | ||
| volumes: | ||
| - .\vulnerablecode-config:/etc/vulnerablecode/ |
Member
There was a problem hiding this comment.
It might be a good idea to have a special Docker Compose file for Windows, docker-compose.windows.yml
Suggested change
| Create ``docker-compose.override.yml`` with the configuration mount for the | |
| application, scheduler, and both RQ workers:: | |
| services: | |
| vulnerablecode: | |
| volumes: | |
| - .\vulnerablecode-config:/etc/vulnerablecode/ | |
| vulnerablecode_scheduler: | |
| volumes: | |
| - .\vulnerablecode-config:/etc/vulnerablecode/ | |
| vulnerablecode_rqworker: | |
| volumes: | |
| - .\vulnerablecode-config:/etc/vulnerablecode/ | |
| vulnerablecode_rqworker_high: | |
| volumes: | |
| - .\vulnerablecode-config:/etc/vulnerablecode/ |
Author
There was a problem hiding this comment.
Added the dedicated docker-compose.windows.yml override and updated the Windows instructions to use it explicitly.
Comment on lines
-108
to
-110
| .. warning:: | ||
| On **Windows** VulnerableCode can **only** :ref:`run_with_docker` and is not supported. | ||
|
|
Member
There was a problem hiding this comment.
Why do we need to remove that?
Author
There was a problem hiding this comment.
I retained and clarified the warning: native Windows installation is not supported, while Docker Desktop is supported. It now points to the Docker installation instructions.
gunjansonaw
force-pushed
the
docs/windows-docker-setup
branch
from
October 8, 2026 09:53
2237aa2 to
f8ab85d
Compare
gunjansonaw
force-pushed
the
docs/windows-docker-setup
branch
from
November 8, 2026 05:35
0ea4bf2 to
2bcccf4
Compare
Signed-off-by: Gunjan Sonawane <gunjansonawane462@gmail.com>
gunjansonaw
force-pushed
the
docs/windows-docker-setup
branch
from
November 8, 2026 06:04
2bcccf4 to
b4d186c
Compare
Author
|
@ziadhany I've addressed your review comments:
Tested from a fresh clone with an empty database on Windows with Docker Desktop: all migrations applied, all 7 services running, and http://localhost returns HTTP 200. Could you take another look when you have time? Thanks! |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.envcontents forSECRET_KEYandALTCHA_HMAC_KEYwith placeholder values (no secret generation), sincemake envfileis not available on Windows.docker-compose.windows.ymlto mount./vulnerablecode-configas/etc/vulnerablecode/.vulnerablecode-config/so secrets are never committed.Testing
git diff --checkpasses.Notes
The Windows instructions are Docker-based because native Windows installation is not supported.