Skip to content

Commit 3ad0bb9

Browse files
Merge branch 'main' into webhook-docs
2 parents 281b29e + acd3193 commit 3ad0bb9

File tree

21 files changed

+304
-360
lines changed

21 files changed

+304
-360
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,10 @@ MinAlertLevel = error
120120

121121
### Running Vale
122122

123-
1. Linting Documentation: To check all markdown files in versioned_docs/version-2.0.0/ for errors, run:
123+
1. Linting Documentation: To check all markdown files in versioned_docs/version-3.0.0/ for errors, run:
124124

125125
```bash
126-
vale versioned_docs/version-2.0.0/**/*.md
126+
vale versioned_docs/version-3.0.0/**/*.md
127127
```
128128

129129
2. Review Errors:

docusaurus.config.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,12 @@ module.exports = {
161161
position: "right",
162162
dropdownActiveClassDisabled: true,
163163
},
164+
{
165+
href: "https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg",
166+
position: "right",
167+
className: "header-slack-link",
168+
"aria-label": "Join our Slack community",
169+
},
164170
{
165171
href: "https://github.com/keploy/keploy",
166172
position: "right",
@@ -178,6 +184,7 @@ module.exports = {
178184
</g>
179185
</svg></a>
180186
<a href="https://www.youtube.com/channel/UC6OTg7F4o0WkmNtSoob34lg" aria-label="YouTube"><svg class="footer__svg" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M19.615 3.184c-3.604-.246-11.631-.245-15.23 0-3.897.266-4.356 2.62-4.385 8.816.029 6.185.484 8.549 4.385 8.816 3.6.245 11.626.246 15.23 0 3.897-.266 4.356-2.62 4.385-8.816-.029-6.185-.484-8.549-4.385-8.816zm-10.615 12.816v-8l8 3.993-8 4.007z"/></svg></a>
187+
<a href="https://www.instagram.com/keploy.io/" aria-label="Instagram"><svg class="footer__svg" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M12 2.163c3.204 0 3.584.012 4.85.07 3.252.148 4.771 1.691 4.919 4.919.058 1.265.069 1.645.069 4.849 0 3.205-.012 3.584-.069 4.849-.149 3.225-1.664 4.771-4.919 4.919-1.266.058-1.644.07-4.85.07-3.204 0-3.584-.012-4.849-.07-3.26-.149-4.771-1.699-4.919-4.92-.058-1.265-.07-1.644-.07-4.849 0-3.204.013-3.583.07-4.849.149-3.227 1.664-4.771 4.919-4.919 1.266-.057 1.645-.069 4.849-.069zm0-2.163c-3.259 0-3.667.014-4.947.072-4.358.2-6.78 2.618-6.98 6.98-.059 1.281-.073 1.689-.073 4.948 0 3.259.014 3.668.072 4.948.2 4.358 2.618 6.78 6.98 6.98 1.281.058 1.689.072 4.948.072 3.259 0 3.668-.014 4.948-.072 4.354-.2 6.782-2.618 6.979-6.98.059-1.28.073-1.689.073-4.948 0-3.259-.014-3.667-.072-4.947-.196-4.354-2.617-6.78-6.979-6.98-1.281-.059-1.69-.073-4.949-.073zm0 5.838c-3.403 0-6.162 2.759-6.162 6.162s2.759 6.163 6.162 6.163 6.162-2.759 6.162-6.163c0-3.403-2.759-6.162-6.162-6.162zm0 10.162c-2.209 0-4-1.79-4-4 0-2.209 1.791-4 4-4s4 1.791 4 4c0 2.21-1.791 4-4 4zm6.406-11.845c-.796 0-1.441.645-1.441 1.44s.645 1.44 1.441 1.44c.795 0 1.439-.645 1.439-1.44s-.644-1.44-1.439-1.44z"/></svg></a>
181188
<a href="https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg" aria-label="Slack"><svg class="footer__svg" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 2447.6 2452.5">
182189
<path d="m897.4 0c-135.3.1-244.8 109.9-244.7 245.2-.1 135.3 109.5 245.1 244.8 245.2h244.8v-245.1c.1-135.3-109.5-245.1-244.9-245.3.1 0 .1 0 0 0m0 654h-652.6c-135.3.1-244.9 109.9-244.8 245.2-.2 135.3 109.4 245.1 244.7 245.3h652.7c135.3-.1 244.9-109.9 244.8-245.2.1-135.4-109.5-245.2-244.8-245.3z" /><path d="m2447.6 899.2c.1-135.3-109.5-245.1-244.8-245.2-135.3.1-244.9 109.9-244.8 245.2v245.3h244.8c135.3-.1 244.9-109.9 244.8-245.3zm-652.7 0v-654c.1-135.2-109.4-245-244.7-245.2-135.3.1-244.9 109.9-244.8 245.2v654c-.2 135.3 109.4 245.1 244.7 245.3 135.3-.1 244.9-109.9 244.8-245.3z" /><path d="m1550.1 2452.5c135.3-.1 244.9-109.9 244.8-245.2.1-135.3-109.5-245.1-244.8-245.2h-244.8v245.2c-.1 135.2 109.5 245 244.8 245.2zm0-654.1h652.7c135.3-.1 244.9-109.9 244.8-245.2.2-135.3-109.4-245.1-244.7-245.3h-652.7c-135.3.1-244.9 109.9-244.8 245.2-.1 135.4 109.4 245.2 244.7 245.3z" /><path d="m0 1553.2c-.1 135.3 109.5 245.1 244.8 245.2 135.3-.1 244.9-109.9 244.8-245.2v-245.2h-244.8c-135.3.1-244.9 109.9-244.8 245.2zm652.7 0v654c-.2 135.3 109.4 245.1 244.7 245.3 135.3-.1 244.9-109.9 244.8-245.2v-653.9c.2-135.3-109.4-245.1-244.7-245.3-135.4 0-244.9 109.8-244.8 245.1 0 0 0 .1 0 0"/>
183190
</svg></a>

src/components/Resources.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
33
import Link from "@docusaurus/Link";
44

55
const links = [
6+
{
7+
type: "video",
8+
title: "AI Powered API testing",
9+
length: "1 min watch",
10+
url: "https://youtu.be/W6kh-TCUQH0?feature=shared",
11+
},
612
{
713
type: "article",
814
title: "What's Keploy?",

src/css/custom.css

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
--ifm-link-hover-color: inherit;
3333
--site-primary-hue-saturation: 30 100%;
3434
--site-primary-hue-saturation-light: 0 0%; /* do we really need this extra one? */
35+
--slack-logo: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 1610 1610'%3E%3Cpath fill='%23E01E5A' d='M338 1017c0 93-76 169-169 169S0 1110 0 1017s76-169 169-169h169v169zM423 1017c0-93 76-169 169-169s169 76 169 169v424c0 93-76 169-169 169s-169-76-169-169v-424z'/%3E%3Cpath fill='%2336C5F0' d='M593 338c-93 0-169-76-169-169S500 0 593 0s169 76 169 169v169H593zM593 423c93 0 169 76 169 169s-76 169-169 169H169C76 761 0 685 0 592s76-169 169-169h424z'/%3E%3Cpath fill='%232EB67D' d='M1272 593c0-93 76-169 169-169s169 76 169 169-76 169-169 169h-169V593zM1187 593c0 93-76 169-169 169s-169-76-169-169V169C849 76 925 0 1018 0s169 76 169 169v424z'/%3E%3Cpath fill='%23ECB22E' d='M1017 1272c93 0 169 76 169 169s-76 169-169 169-169-76-169-169v-169h169zM1017 1187c-93 0-169-76-169-169s76-169 169-169h424c93 0 169 76 169 169s-76 169-169 169h-424z'/%3E%3C/svg%3E");
3536
}
3637

3738
html[data-theme="dark"] {
@@ -228,6 +229,7 @@ div[class^="sidebar_"] .button svg {
228229

229230
.navbar__items--right {
230231
@apply justify-end ml-auto flex-row-reverse;
232+
gap: 13px;
231233
}
232234

233235
.navbar__items--right > :last-child {
@@ -551,6 +553,25 @@ td img {
551553
no-repeat;
552554
}
553555

556+
/* Slack navbar icon to match GitHub size, spacing, color */
557+
.header-slack-link:hover {
558+
opacity: 0.6;
559+
}
560+
561+
.header-slack-link::before {
562+
content: "";
563+
width: 24px;
564+
height: 24px;
565+
display: flex;
566+
background: var(--slack-logo) no-repeat;
567+
background-size: 24px 24px;
568+
}
569+
570+
[data-theme="dark"] .header-slack-link::before {
571+
background: var(--slack-logo) no-repeat;
572+
background-size: 24px 24px;
573+
}
574+
554575
div[class^="announcementBar_"] {
555576
--site-announcement-bar-stripe-color1: hsl(
556577
var(--site-primary-hue-saturation) 88%

versioned_docs/version-2.0.0/concepts/installation.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ Use "keploy [command] --help" for more information about a command.
7171
<details>
7272
<summary>Install using Docker</summary>
7373

74-
### Downloading and running Keploy in Docker
74+
**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

@@ -85,10 +85,24 @@ Note : Keploy is not supported natively on MacOS, so you can follow the below me
8585
docker network create keploy-network
8686
```
8787

88-
3. Run the following command to start the Keploy container:
88+
2. Install Keploy
89+
90+
```shell
91+
curl --silent -O -L https://keploy.io/install.sh && source install.sh
92+
```
93+
94+
#### Examples:
95+
96+
**Record:**
97+
98+
```bash
99+
keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60
100+
```
101+
102+
**Test:**
89103

90104
```bash
91-
alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-network --privileged --pid=host -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy"
105+
keploy test --c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --delay 10 --buildDelay 60
92106
```
93107

94108
</details>
@@ -129,7 +143,7 @@ sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
129143

130144
> Note: Keploy is not supported on MacOS natively.
131145
132-
### Setting up the Docker Desktop for WSL 2
146+
**Setting up the Docker Desktop for WSL 2**
133147

134148
1. Install Docker Desktop for Windows from [here](https://docs.docker.com/desktop/windows/install/).
135149

versioned_docs/version-2.0.0/concepts/platform-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Linux:
2727

2828
| Operating System | Without Docker | Docker Installation | Prerequisites |
2929
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30-
| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" /> **MacOS** | <img src="https://upload.wikimedia.org/wikipedia/en/b/ba/Red_x.svg" width="20" height="20" alt="Not Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | - Docker Desktop version must be 4.25.2 or above<br/> - For running Keploy on MacOS natively, refer to [Guide](/keploy-explained/mac-linux.md) |
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/> |
3131
| <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 |
3232
| <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

versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

Lines changed: 30 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -6,123 +6,58 @@ sidebar_label: Keploy on MacOS native
66

77
# Running Keploy Natively on MacOS by setting up a linux env
88

9-
### Downloading and running Keploy in Native using Debian on MacOS
9+
**_Downloading and running Keploy in Native using Debian on MacOS_**
1010

1111
1. Open the terminal Session.
1212
2. Run the following command. This installs homebrew and makes it easier to manage software and packages on macOS
1313

14-
```bash
15-
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
16-
```
14+
```bash
15+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
16+
```
1717

1818
3. Now, with the help of homebrew, we would install Lima (Linux Virtual Machine) by running this command.
1919

20-
```bash
21-
brew install lima
22-
```
20+
```bash
21+
brew install lima
22+
```
2323

2424
4. Create a Debian instance.
2525

26-
```bash
27-
limactl create template://debian-12
28-
```
26+
```bash
27+
limactl create template://debian-12
28+
```
2929

3030
5. Start the instance
3131

32-
```bash
33-
limactl start debian-12
34-
```
32+
```bash
33+
limactl start debian-12
34+
```
3535

3636
6. Enter the shell of the running linux instance
3737

38-
```bash
39-
limactl shell debian-12
40-
```
38+
```bash
39+
limactl shell debian-12
40+
```
4141

42-
7. Now you are in the linux shell of the debian instance. Now, run the following command to go the `Users` into your directory
42+
7. Now you are in the linux shell of the debian instance. Replace `{Username}` with your actual macOS username in the following command. This will take you directly to your macOS home directory. (You might need to allow access to Terminal.app in a popup)
4343

44-
```bash
45-
cd /Users
46-
```
44+
```bash
45+
cd /Users/{Username}
46+
```
4747

48-
8. Replace the `Username` with your macOS username in the following command. This will take you to your macOS home directory. (You might need to allow access to Terminal.app in a popup)
48+
8. Run the following command to install Keploy
4949

50-
```bash
51-
cd /{Username}
52-
```
50+
```bash
51+
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
52+
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
53+
```
5354

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

56-
```bash
57-
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
58-
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
59-
```
57+
## What's Next?
6058

61-
10. Run the following command to install Zsh
59+
### 🎬 [Start Capturing Testcases](/docs/server/installation/#-capturing-testcases)
6260

63-
```bash
64-
sudo apt-get -y install zsh
65-
```
61+
Begin recording your API calls and generating test cases with Keploy.
6662

67-
**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.
68-
69-
11. Install Git
70-
71-
```bash
72-
sudo apt-get -y install git
73-
```
74-
75-
12. Install 'Oh-my-zsh'
76-
77-
```bash
78-
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
79-
```
80-
81-
**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.
82-
83-
13. Commands to Install docker
84-
85-
```bash
86-
sudo apt-get -y update
87-
```
88-
89-
```bash
90-
sudo apt-get -y install ca-certificates curl
91-
```
92-
93-
```bash
94-
sudo install -m 0755 -d /etc/apt/keyrings
95-
```
96-
97-
```bash
98-
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
99-
```
100-
101-
```bash
102-
sudo chmod a+r /etc/apt/keyrings/docker.asc
103-
```
104-
105-
```bash
106-
echo \
107-
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
108-
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
109-
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
110-
```
111-
112-
```bash
113-
sudo apt-get -y update
114-
```
115-
116-
```bash
117-
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
118-
```
119-
120-
14. Add docker to sudoers
121-
122-
```bash
123-
sudo groupadd docker
124-
```
125-
126-
```bash
127-
sudo gpasswd -a $USER docker
128-
```
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: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ Use "keploy [command] --help" for more information about a command.
7171
<details>
7272
<summary>Install using Docker</summary>
7373

74-
### Downloading and running Keploy in Docker
74+
**_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

@@ -85,18 +85,32 @@ Note : Keploy is not supported natively on MacOS, so you can follow the below me
8585
docker network create keploy-network
8686
```
8787

88-
3. Run the following command to start the Keploy container:
88+
2. Install Keploy
89+
90+
```shell
91+
curl --silent -O -L https://keploy.io/install.sh && source install.sh
92+
```
93+
94+
#### Examples:
95+
96+
**Record:**
97+
98+
```bash
99+
keploy record -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60
100+
```
101+
102+
**Test:**
89103

90104
```bash
91-
alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-network --privileged --pid=host -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy"
105+
keploy test --c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network <applicationImage>" --delay 10
92106
```
93107

94108
</details>
95109

96110
<details>
97-
<summary>Downloading and running Keploy in Native</summary>
111+
<summary>Install Natively</summary>
98112

99-
### Downloading and running Keploy in Native
113+
**_Downloading and running Keploy in Native_**
100114

101115
**Prequisites:**
102116

@@ -129,7 +143,7 @@ sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
129143

130144
> Note: Keploy is not supported on MacOS natively.
131145
132-
### Setting up the Docker Desktop for WSL 2
146+
**_Setting up the Docker Desktop for WSL 2_**
133147

134148
1. Install Docker Desktop for Windows from [here](https://docs.docker.com/desktop/windows/install/).
135149

0 commit comments

Comments
 (0)