fix: changed the windows and lima installation guide (#644)

Achanandhi-M · web-flow · commit 4bfad0a9a485 · 2025-09-04T15:18:27.000+05:30
* fix: changed the alias  and modified lima setup

Signed-off-by: Achanandhi-M &lt;achanandhi.m@gmail.com&gt;

* fix: changed the alias  and modified lima setup

Signed-off-by: Achanandhi-M &lt;achanandhi.m@gmail.com&gt;

* fix:changed the windows and lima installation guide

Signed-off-by: Achanandhi-M &lt;achanandhi.m@gmail.com&gt;

---------

Signed-off-by: Achanandhi-M &lt;achanandhi.m@gmail.com&gt;
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -162,8 +162,7 @@ module.exports = {
           dropdownActiveClassDisabled: true,
         },
         {
-          href:
-            "https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg",
+          href: "https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg",
           position: "right",
           className: "header-slack-link",
           "aria-label": "Join our Slack community",
diff --git a/versioned_docs/version-2.0.0/concepts/installation.md b/versioned_docs/version-2.0.0/concepts/installation.md
@@ -73,9 +73,9 @@ Use "keploy [command] --help" for more information about a command.
 
 **Downloading and running Keploy in Docker**
 
-#### On macOS
+#### On macOS/Windows
 
-Note : Keploy is not supported natively on MacOS, so you can follow the below method to run with docker
+Note : Keploy is not supported natively on MacOS and Windows, so you can follow the below method to run with docker
 
 1. Open up a terminal window.
 
diff --git a/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md
@@ -52,71 +52,12 @@ sidebar_label: Keploy on MacOS native
    sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
    ```
 
-9. Run the following command to install Zsh
+Congratulations! You've successfully set up Keploy natively on MacOS.
 
-   ```bash
-   sudo apt-get -y install zsh
-   ```
-
-   **Why?** : zsh (Z Shell) is an advanced shell that offers enhanced features compared to the default bash shell. It provides better autocompletion, advanced globbing, improved history management, and more customization options.
-
-10. Install Git
-
-    ```bash
-    sudo apt-get -y install git
-    ```
-
-11. Install 'Oh-my-zsh'
-
-    ```bash
-    sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
-    ```
-
-    **Why?** : oh-my-zsh is a framework for managing your zsh configuration. It comes with a collection of plugins, themes, and helpful features that enhance the zsh experience.
-
-12. Commands to Install docker
-
-    ```bash
-    sudo apt-get -y update
-    ```
-
-    ```bash
-    sudo apt-get -y install ca-certificates curl
-    ```
-
-    ```bash
-    sudo install -m 0755 -d /etc/apt/keyrings
-    ```
-
-    ```bash
-    sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
-    ```
-
-    ```bash
-    sudo chmod a+r /etc/apt/keyrings/docker.asc
-    ```
-
-    ```bash
-    echo \
-      "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
-      $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
-      sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-    ```
-
-    ```bash
-    sudo apt-get -y update
-    ```
-
-    ```bash
-    sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
-    ```
+## What's Next?
 
-13. Add docker to sudoers
+### 🎬 [Start Capturing Testcases](/docs/server/installation/#-capturing-testcases)
 
-    ```bash
-    sudo groupadd docker
-    ```
+Begin recording your API calls and generating test cases with Keploy.
 
-    ```bash
-    sudo gpasswd -a $USER docker
-    ```
+#### [Back to Installation Guide](/docs/server/installation/)
diff --git a/versioned_docs/version-2.0.0/server/macos/installation.md b/versioned_docs/version-2.0.0/server/macos/installation.md
@@ -74,7 +74,7 @@ Start Colima with defaults
 colima start
 ```
 
-### Creating Alias
+### Create a network
 
 We need to create a custom network for Keploy since we are using the Docker, therefore application container would
 require `docker network` to act as the bridge between them.
diff --git a/versioned_docs/version-2.0.0/server/windows/installation.md b/versioned_docs/version-2.0.0/server/windows/installation.md
@@ -104,7 +104,7 @@ By default, Docker Desktop may not be configured to work with all WSL 2 distros
 
 For detailed instructions on how to configure `Docker Desktop` for WSL 2, please refer to the [official Docker documentation](https://docs.docker.com/desktop/wsl/).
 
-### Creating Alias
+### Create a network
 
 We need to create a custom network for Keploy since we are using the Docker, therefore application container would
 require `docker network` to act as the bridge between them.
diff --git a/versioned_docs/version-3.0.0/concepts/installation.md b/versioned_docs/version-3.0.0/concepts/installation.md
@@ -73,9 +73,9 @@ Use "keploy [command] --help" for more information about a command.
 
 **_Downloading and running Keploy in Docker_**
 
-#### On macOS
+#### On macOS/Windows
 
-Note : Keploy is not supported natively on MacOS, so you can follow the below method to run with docker
+Note : Keploy is not supported natively on MacOS and Windows, so you can follow the below method to run with docker
 
 1. Open up a terminal window.
 
@@ -96,13 +96,13 @@ docker network create keploy-network
 **Record:**
 
 ```bash
-keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60
+keploy record -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60
 ```
 
 **Test:**
 
 ```bash
-keploy test --c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --delay 10 --buildDelay 60
+keploy test --c "docker run -p <appPort>:<hostPort>  --name <containerName> --network keploy-network <applicationImage>" --delay 10
 ```
 
 </details>
diff --git a/versioned_docs/version-3.0.0/concepts/platform-requirements.md b/versioned_docs/version-3.0.0/concepts/platform-requirements.md
@@ -25,10 +25,10 @@ keywords:
 Below is a table summarizing the tools needed for both native and Docker installations of Keploy on MacOS, Windows, and
 Linux:
 
-| Operating System                                                                                                                                                                                                                                                                                              | Without Docker                                                                                                                  | Docker Installation                                                                                                             | Prerequisites                                                                                                                                                                            |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" /> **MacOS**                                                                                                                                                                     | [Guide](/keploy-explained/mac-linux.md)                                                                                         | [Guide](/docs/server/installation/#other-installation-methods)                                                                  | - Docker Desktop version must be 4.25.2 or above<br/>                                                                                                                                    |
-| <img src="https://upload.wikimedia.org/wikipedia/commons/5/5f/Windows_logo_-_2012.svg" width="15" height="15" alt="Windows" /> **Windows**                                                                                                                                                                    | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install` <br/> - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 |
-| <img src="https://th.bing.com/th/id/R.7802b52b7916c00014450891496fe04a?rik=r8GZM4o2Ch1tHQ&riu=http%3a%2f%2f1000logos.net%2fwp-content%2fuploads%2f2017%2f03%2fLINUX-LOGO.png&ehk=5m0lBvAd%2bzhvGg%2fu4i3%2f4EEHhF4N0PuzR%2fBmC1lFzfw%3d&risl=&pid=ImgRaw&r=0" width="10" height="10" alt="Linux" /> **Linux** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | Linux kernel 5.15 or higher                                                                                                                                                              |
+| Operating System                                                                                                                                                                                                                                                                                              | Without Docker                                                                                                                  | Docker Installation                                                                                                             | Prerequisites                                                                                                                                                                                                                                                                                                       |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" /> **MacOS**                                                                                                                                                                     | [Guide](/keploy-explained/mac-linux.md)                                                                                         | [Guide](/docs/server/installation/#other-installation-methods)                                                                  | - Docker Desktop version must be 4.25.2 or above <br/> - Ensure that Lima is installed on your machine if you prefer to try without Docker.                                                                                                                                                                         |
+| <img src="https://upload.wikimedia.org/wikipedia/commons/5/5f/Windows_logo_-_2012.svg" width="15" height="15" alt="Windows" /> **Windows**                                                                                                                                                                    | [Guide](/keploy-explained/windows-wsl.md)                                                                                       | [Guide](/docs/server/installation/#other-installation-methods)                                                                  | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install` <br/> - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 <br/> - Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide |
+| <img src="https://th.bing.com/th/id/R.7802b52b7916c00014450891496fe04a?rik=r8GZM4o2Ch1tHQ&riu=http%3a%2f%2f1000logos.net%2fwp-content%2fuploads%2f2017%2f03%2fLINUX-LOGO.png&ehk=5m0lBvAd%2bzhvGg%2fu4i3%2f4EEHhF4N0PuzR%2fBmC1lFzfw%3d&risl=&pid=ImgRaw&r=0" width="10" height="10" alt="Linux" /> **Linux** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | Linux kernel 5.15 or higher                                                                                                                                                                                                                                                                                         |
 
 On MacOS and Windows, additional tools are required for Keploy due to the lack of native eBPF support.
diff --git a/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md
@@ -52,76 +52,7 @@ sidebar_label: Keploy on MacOS native
     sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
     ```
 
-9.  Run the following command to install Zsh
-
-    ```bash
-    sudo apt-get -y install zsh
-    ```
-
-    **Why?** : zsh (Z Shell) is an advanced shell that offers enhanced features compared to the default bash shell. It provides better autocompletion, advanced globbing, improved history management, and more customization options.
-
-10. Install Git
-
-    ```bash
-    sudo apt-get -y install git
-    ```
-
-11. Install 'Oh-my-zsh'
-
-    ```bash
-    sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
-    ```
-
-    **Why?** : oh-my-zsh is a framework for managing your zsh configuration. It comes with a collection of plugins, themes, and helpful features that enhance the zsh experience.
-
-12. Commands to Install docker
-
-    ```bash
-    sudo apt-get -y update
-    ```
-
-    ```bash
-    sudo apt-get -y install ca-certificates curl
-    ```
-
-    ```bash
-    sudo install -m 0755 -d /etc/apt/keyrings
-    ```
-
-    ```bash
-    sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
-    ```
-
-    ```bash
-    sudo chmod a+r /etc/apt/keyrings/docker.asc
-    ```
-
-    ```bash
-    echo \
-      "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
-      $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
-      sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-    ```
-
-    ```bash
-    sudo apt-get -y update
-    ```
-
-    ```bash
-    sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
-    ```
-
-13. Add docker to sudoers
-
-        ```bash
-        sudo groupadd docker
-        ```
-
-        ```bash
-        sudo gpasswd -a $USER docker
-        ```
-
-    Congratulations! You've successfully set up Keploy natively on MacOS.
+Congratulations! You've successfully set up Keploy natively on MacOS.
 
 ## What's Next?
 
diff --git a/versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md b/versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md
@@ -0,0 +1,45 @@
+---
+id: windows-wsl
+title: "Running Keploy Natively on Windows"
+sidebar_label: Keploy on Windows native
+tags:
+  - windows
+  - ebpf
+  - windows installation
+  - installation
+  - installation-guide
+keywords:
+  - windows
+  - ebpf
+  - installation
+---
+
+On Windows, WSL is required to run Keploy Binary. You must be running Windows 10 version 2004 and higher (Build 19041
+and higher) or Windows 11 to use the commands below.
+
+```shell
+wsl --install -d <Distribution Name>
+```
+
+Recommended to use "Ubuntu-22.04"
+
+This command will enable the features necessary to run WSL and install the Ubuntu distribution of Linux. (This default
+distribution can be changed).
+
+Install "Keploy Binary" :
+
+```shell
+curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz -C /tmp
+
+sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin && keploy
+```
+
+Congratulations! You've successfully set up Keploy natively on Windows.
+
+## What's Next?
+
+### 🎬 [Start Capturing Testcases](/docs/server/installation/#-capturing-testcases)
+
+Begin recording your API calls and generating test cases with Keploy.
+
+#### [Back to Installation Guide](/docs/server/installation/)
diff --git a/versioned_docs/version-3.0.0/server/windows/installation.md b/versioned_docs/version-3.0.0/server/windows/installation.md
@@ -104,7 +104,7 @@ By default, Docker Desktop may not be configured to work with all WSL 2 distros
 
 For detailed instructions on how to configure `Docker Desktop` for WSL 2, please refer to the [official Docker documentation](https://docs.docker.com/desktop/wsl/).
 
-### Creating Alias
+### Create a network
 
 We need to create a custom network for Keploy since we are using the Docker, therefore application container would
 require `docker network` to act as the bridge between them.
