forked from juice-shop/multi-juicer
-
-
Notifications
You must be signed in to change notification settings - Fork 17
docs: add detailed windows setup guide #969
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Windows Development Setup Guide for WrongSecrets CTF Party | ||
|
|
||
| This guide provides a step-by-step process for setting up the local development environment for WrongSecrets CTF Party on a Windows machine. | ||
|
|
||
| ## 1. Prerequisites | ||
|
|
||
| Before you begin, you must install the following tools: | ||
| - **Git:** [https://git-scm.com/downloads](https://git-scm.com/downloads) (Ensure **Git Bash** is installed) | ||
| - **Docker Desktop for Windows:** [https://www.docker.com/products/docker-desktop/](https://www.docker.com/products/docker-desktop/) | ||
| - **Minikube:** [https://minikube.sigs.k8s.io/docs/start/](https://minikube.sigs.k8s.io/docs/start/) | ||
| - **Helm:** [https://helm.sh/docs/intro/install/](https://helm.sh/docs/intro/install/) | ||
| - **kubectl:** (Included with Docker Desktop) | ||
| - **yq:** [https://github.com/mikefarah/yq/#install](https://github.com/mikefarah/yq/#install) | ||
|
|
||
| ## 2. System Configuration | ||
|
|
||
| These Windows-specific configurations are crucial for a successful setup. | ||
|
|
||
| ### a. Enable Hardware Virtualization (BIOS/UEFI) | ||
|
|
||
| Minikube and Docker require hardware virtualization (VT-x or AMD-V) to be enabled in your computer's BIOS/UEFI. You will need to restart your computer and press a key (like `F2`, `F10`, or `DEL`) during boot to enter the setup menu. Search online for instructions specific to your computer model. | ||
|
|
||
| ### b. Configure Docker Desktop Memory (WSL 2) | ||
|
|
||
| The project requires at least 11GB of RAM. You must configure Docker's WSL 2 backend to provide this memory. | ||
| 1. Create a file named `.wslconfig` in your user profile folder (`C:\Users\YourName`). | ||
| 2. Add the following content: | ||
| ```ini | ||
| [wsl2] | ||
| memory=12GB | ||
| ``` | ||
| 3. Restart the WSL service by running `wsl --shutdown` in PowerShell, then restart Docker Desktop. | ||
|
|
||
| ## 3. Manual Deployment Guide | ||
|
|
||
| The included scripts have compatibility issues on Windows. A manual deployment is more reliable. Run these commands in **Git Bash**: | ||
|
|
||
| 1. **Start Minikube Cluster:** | ||
| ```bash | ||
| minikube start --cpus=4 --memory=11000MB --driver=docker --network-plugin=cni --cni=calico | ||
commjoen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
seershan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 2. **Update Helm Repositories:** | ||
| ```bash | ||
| helm repo update | ||
| ``` | ||
| 3. **Deploy the Application:** | ||
| ```bash | ||
| helm upgrade --install wrongsecrets ./helm/wrongsecrets-ctf-party | ||
| ``` | ||
| 4. **Check Pod Status:** | ||
| ```bash | ||
| kubectl get pods --watch | ||
| ``` | ||
| Wait for `wrongsecrets-balancer` to be `Running` and `1/1`, then press `Ctrl + C`. | ||
|
|
||
| 5. **Access the Application:** | ||
| In a new terminal, run: | ||
| ```bash | ||
| kubectl port-forward service/wrongsecrets-balancer 3000:3000 | ||
| ``` | ||
| The application is now available at `http://localhost:3000`. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.