Repository navigation
docs: add Windows Docker installation instructions - #2427
Open
gunjansonaw wants to merge 2 commits into
Open
gunjansonaw wants to merge 2 commits into
gunjansonaw wants to merge 2 commits into
Conversation
gunjansonaw
force-pushed
the
docs/windows-docker-setup
branch
from
September 2, 2026 16:36
f3cddd8 to
991e20c
Compare
Signed-off-by: Gunjan Sonawane <gunjansonawane462@gmail.com>
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/ |
Collaborator
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. | ||
|
|
Collaborator
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.
Comment on lines
+104
to
+121
| Create the configuration directory and environment file using PowerShell. The | ||
| following commands generate secure values for both required settings:: | ||
|
|
||
| New-Item -ItemType Directory -Force .\vulnerablecode-config | ||
| $secretKeyBytes = New-Object byte[] 50 | ||
| $rng = [System.Security.Cryptography.RandomNumberGenerator]::Create() | ||
| $rng.GetBytes($secretKeyBytes) | ||
| $secretKey = [Convert]::ToBase64String($secretKeyBytes) | ||
|
|
||
| $altchaKeyBytes = New-Object byte[] 32 | ||
| $rng.GetBytes($altchaKeyBytes) | ||
| $altchaHmacKey = -join ($altchaKeyBytes | ForEach-Object { $_.ToString("x2") }) | ||
| $rng.Dispose() | ||
|
|
||
| @" | ||
| SECRET_KEY="$secretKey" | ||
| ALTCHA_HMAC_KEY="$altchaHmacKey" | ||
| "@ | Set-Content .\vulnerablecode-config\.env |
Collaborator
There was a problem hiding this comment.
Please avoid generating any environment variables.
Author
There was a problem hiding this comment.
Removed the PowerShell secret-generation commands. The docs now show placeholder values only and tell users to replace them with unique secrets.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Gunjan Sonawane <gunjansonawane462@gmail.com>
gunjansonaw
force-pushed
the
docs/windows-docker-setup
branch
from
October 8, 2026 09:53
2237aa2 to
f8ab85d
Compare
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
2 participants
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
Add Windows-specific Docker installation instructions.
Document PowerShell-based environment configuration.
Document the Windows Docker Compose override required to mount the configuration directory.
Remove the previous generic Windows warning now that dedicated instructions are available.
### Testing
Verified the Windows Docker setup locally with Docker Desktop.
Confirmed the application starts successfully with the documented configuration.
Confirmed http://localhost returns HTTP 200.
git diff --check passes.
Notes
The Windows instructions are Docker-based because native Windows installation is not supported.