Skip to content

Commit 4bfad0a

Browse files
Achanandhi-MAchanandhi-M
authored
fix: changed the windows and lima installation guide (#644)
* fix: changed the alias and modified lima setup Signed-off-by: Achanandhi-M <[email protected]> * fix: changed the alias and modified lima setup Signed-off-by: Achanandhi-M <[email protected]> * fix:changed the windows and lima installation guide Signed-off-by: Achanandhi-M <[email protected]> --------- Signed-off-by: Achanandhi-M <[email protected]>
1 parent 470f18c commit 4bfad0a

File tree

10 files changed

+66
-150
lines changed

10 files changed

+66
-150
lines changed

‎docusaurus.config.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,7 @@ module.exports = {
162162
dropdownActiveClassDisabled: true,
163163
},
164164
{
165-
href:
166-
"https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg",
165+
href: "https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg",
167166
position: "right",
168167
className: "header-slack-link",
169168
"aria-label": "Join our Slack community",

‎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-2.0.0/keploy-explained/mac-linux.md

Lines changed: 5 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -52,71 +52,12 @@ sidebar_label: Keploy on MacOS native
5252
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
5353
```
5454

55-
9. Run the following command to install Zsh
55+
Congratulations! You've successfully set up Keploy natively on MacOS.
5656

57-
```bash
58-
sudo apt-get -y install zsh
59-
```
60-
61-
**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.
62-
63-
10. Install Git
64-
65-
```bash
66-
sudo apt-get -y install git
67-
```
68-
69-
11. Install 'Oh-my-zsh'
70-
71-
```bash
72-
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
73-
```
74-
75-
**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.
76-
77-
12. Commands to Install docker
78-
79-
```bash
80-
sudo apt-get -y update
81-
```
82-
83-
```bash
84-
sudo apt-get -y install ca-certificates curl
85-
```
86-
87-
```bash
88-
sudo install -m 0755 -d /etc/apt/keyrings
89-
```
90-
91-
```bash
92-
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
93-
```
94-
95-
```bash
96-
sudo chmod a+r /etc/apt/keyrings/docker.asc
97-
```
98-
99-
```bash
100-
echo \
101-
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
102-
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
103-
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
104-
```
105-
106-
```bash
107-
sudo apt-get -y update
108-
```
109-
110-
```bash
111-
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
112-
```
57+
## What's Next?
11358

114-
13. Add docker to sudoers
59+
### 🎬 [Start Capturing Testcases](/docs/server/installation/#-capturing-testcases)
11560

116-
```bash
117-
sudo groupadd docker
118-
```
61+
Begin recording your API calls and generating test cases with Keploy.
11962

120-
```bash
121-
sudo gpasswd -a $USER docker
122-
```
63+
#### [Back to Installation Guide](/docs/server/installation/)

‎versioned_docs/version-2.0.0/server/macos/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Start Colima with defaults
7474
colima start
7575
```
7676

77-
### Creating Alias
77+
### Create a network
7878

7979
We need to create a custom network for Keploy since we are using the Docker, therefore application container would
8080
require `docker network` to act as the bridge between them.

‎versioned_docs/version-2.0.0/server/windows/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ By default, Docker Desktop may not be configured to work with all WSL 2 distros
104104
105105
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/).
106106

107-
### Creating Alias
107+
### Create a network
108108

109109
We need to create a custom network for Keploy since we are using the Docker, therefore application container would
110110
require `docker network` to act as the bridge between them.

‎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/mac-linux.md

Lines changed: 1 addition & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -52,76 +52,7 @@ sidebar_label: Keploy on MacOS native
5252
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
5353
```
5454

55-
9. Run the following command to install Zsh
56-
57-
```bash
58-
sudo apt-get -y install zsh
59-
```
60-
61-
**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.
62-
63-
10. Install Git
64-
65-
```bash
66-
sudo apt-get -y install git
67-
```
68-
69-
11. Install 'Oh-my-zsh'
70-
71-
```bash
72-
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
73-
```
74-
75-
**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.
76-
77-
12. Commands to Install docker
78-
79-
```bash
80-
sudo apt-get -y update
81-
```
82-
83-
```bash
84-
sudo apt-get -y install ca-certificates curl
85-
```
86-
87-
```bash
88-
sudo install -m 0755 -d /etc/apt/keyrings
89-
```
90-
91-
```bash
92-
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
93-
```
94-
95-
```bash
96-
sudo chmod a+r /etc/apt/keyrings/docker.asc
97-
```
98-
99-
```bash
100-
echo \
101-
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
102-
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
103-
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
104-
```
105-
106-
```bash
107-
sudo apt-get -y update
108-
```
109-
110-
```bash
111-
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
112-
```
113-
114-
13. Add docker to sudoers
115-
116-
```bash
117-
sudo groupadd docker
118-
```
119-
120-
```bash
121-
sudo gpasswd -a $USER docker
122-
```
123-
124-
Congratulations! You've successfully set up Keploy natively on MacOS.
55+
Congratulations! You've successfully set up Keploy natively on MacOS.
12556
12657
## What's Next?
12758

‎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/)

‎versioned_docs/version-3.0.0/server/windows/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ By default, Docker Desktop may not be configured to work with all WSL 2 distros
104104
105105
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/).
106106

107-
### Creating Alias
107+
### Create a network
108108

109109
We need to create a custom network for Keploy since we are using the Docker, therefore application container would
110110
require `docker network` to act as the bridge between them.

0 commit comments

Comments
 (0)