Skip to content

Commit 5d3a0f9

Browse files
Achanandhi-MAchanandhi-M
committed
fix:changed the windows and lima installation guide
Signed-off-by: Achanandhi-M <[email protected]>
1 parent edf93c8 commit 5d3a0f9

File tree

4 files changed

+56
-11
lines changed

4 files changed

+56
-11
lines changed

‎versioned_docs/version-2.0.0/concepts/installation.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ Use "keploy [command] --help" for more information about a command.
7373

7474
**Downloading and running Keploy in Docker**
7575

76-
#### On macOS
76+
#### On macOS/Windows
7777

78-
Note : Keploy is not supported natively on MacOS, so you can follow the below method to run with docker
78+
Note : Keploy is not supported natively on MacOS and Windows, so you can follow the below method to run with docker
7979

8080
1. Open up a terminal window.
8181

‎versioned_docs/version-3.0.0/concepts/installation.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ Use "keploy [command] --help" for more information about a command.
7373

7474
**_Downloading and running Keploy in Docker_**
7575

76-
#### On macOS
76+
#### On macOS/Windows
7777

78-
Note : Keploy is not supported natively on MacOS, so you can follow the below method to run with docker
78+
Note : Keploy is not supported natively on MacOS and Windows, so you can follow the below method to run with docker
7979

8080
1. Open up a terminal window.
8181

@@ -96,13 +96,13 @@ docker network create keploy-network
9696
**Record:**
9797

9898
```bash
99-
keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60
99+
keploy record -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60
100100
```
101101

102102
**Test:**
103103

104104
```bash
105-
keploy test --c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --delay 10 --buildDelay 60
105+
keploy test --c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network <applicationImage>" --delay 10
106106
```
107107

108108
</details>

‎versioned_docs/version-3.0.0/concepts/platform-requirements.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ keywords:
2525
Below is a table summarizing the tools needed for both native and Docker installations of Keploy on MacOS, Windows, and
2626
Linux:
2727

28-
| Operating System | Without Docker | Docker Installation | Prerequisites |
29-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30-
| <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/> |
31-
| <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 |
32-
| <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 |
28+
| Operating System | Without Docker | Docker Installation | Prerequisites |
29+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30+
| <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. |
31+
| <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 |
32+
| <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 |
3333

3434
On MacOS and Windows, additional tools are required for Keploy due to the lack of native eBPF support.

‎versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: windows-wsl
3+
title: "Running Keploy Natively on Windows"
4+
sidebar_label: Keploy on Windows native
5+
tags:
6+
- windows
7+
- ebpf
8+
- windows installation
9+
- installation
10+
- installation-guide
11+
keywords:
12+
- windows
13+
- ebpf
14+
- installation
15+
---
16+
17+
On Windows, WSL is required to run Keploy Binary. You must be running Windows 10 version 2004 and higher (Build 19041
18+
and higher) or Windows 11 to use the commands below.
19+
20+
```shell
21+
wsl --install -d <Distribution Name>
22+
```
23+
24+
Recommended to use "Ubuntu-22.04"
25+
26+
This command will enable the features necessary to run WSL and install the Ubuntu distribution of Linux. (This default
27+
distribution can be changed).
28+
29+
Install "Keploy Binary" :
30+
31+
```shell
32+
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz -C /tmp
33+
34+
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin && keploy
35+
```
36+
37+
Congratulations! You've successfully set up Keploy natively on Windows.
38+
39+
## What's Next?
40+
41+
### 🎬 [Start Capturing Testcases](/docs/server/installation/#-capturing-testcases)
42+
43+
Begin recording your API calls and generating test cases with Keploy.
44+
45+
#### [Back to Installation Guide](/docs/server/installation/)

0 commit comments

Comments
 (0)