Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions versioned_docs/version-2.0.0/concepts/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,14 @@
Use "keploy [command] --help" for more information about a command.
```

🎉 Wohoo! You are all set to use Keploy.

Check failure on line 67 in versioned_docs/version-2.0.0/concepts/installation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/concepts/installation.md#L67

[Vale.Spelling] Did you really mean 'Wohoo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Wohoo'?", "location": {"path": "versioned_docs/version-2.0.0/concepts/installation.md", "range": {"start": {"line": 67, "column": 3}}}, "severity": "ERROR"}

## Other Installation Methods

<details>
<summary>Install using Docker</summary>

### Downloading and running Keploy in Docker
**Downloading and running Keploy in Docker**

#### On macOS

Expand All @@ -85,10 +85,24 @@
docker network create keploy-network
```

3. Run the following command to start the Keploy container:
2. Install Keploy

```shell
curl --silent -O -L https://keploy.io/install.sh && source install.sh
```

#### Examples:

**Record:**

```bash
keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60
```

**Test:**

```bash
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"
keploy test --c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --delay 10 --buildDelay 60
```

</details>
Expand All @@ -98,7 +112,7 @@

### Downloading and running Keploy in Native

**Prequisites:**

Check failure on line 115 in versioned_docs/version-2.0.0/concepts/installation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/concepts/installation.md#L115

[Vale.Spelling] Did you really mean 'Prequisites'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Prequisites'?", "location": {"path": "versioned_docs/version-2.0.0/concepts/installation.md", "range": {"start": {"line": 115, "column": 3}}}, "severity": "ERROR"}

- Linux Kernel version 5.15 or higher
- Run `uname -a` to verify the system architecture.
Expand Down Expand Up @@ -129,7 +143,7 @@

> Note: Keploy is not supported on MacOS natively.

### Setting up the Docker Desktop for WSL 2
**Setting up the Docker Desktop for WSL 2**

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ 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** | <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) |
| <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 |

Expand Down
154 changes: 74 additions & 80 deletions versioned_docs/version-2.0.0/keploy-explained/mac-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,125 +4,119 @@
sidebar_label: Keploy on MacOS native
---

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

Check failure on line 7 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L7

[Vale.Spelling] Did you really mean 'linux'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'linux'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 7, "column": 52}}}, "severity": "ERROR"}

Check failure on line 7 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L7

[Vale.Spelling] Did you really mean 'env'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'env'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 7, "column": 58}}}, "severity": "ERROR"}

### Downloading and running Keploy in Native using Debian on MacOS
**_Downloading and running Keploy in Native using Debian on MacOS_**

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

Check failure on line 12 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L12

[Vale.Spelling] Did you really mean 'homebrew'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'homebrew'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 12, "column": 45}}}, "severity": "ERROR"}

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

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

Check failure on line 18 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L18

[Vale.Spelling] Did you really mean 'homebrew'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'homebrew'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 18, "column": 26}}}, "severity": "ERROR"}

```bash
brew install lima
```
```bash
brew install lima
```

4. Create a Debian instance.

```bash
limactl create template://debian-12
```
```bash
limactl create template://debian-12
```

5. Start the instance

```bash
limactl start debian-12
```
```bash
limactl start debian-12
```

6. Enter the shell of the running linux instance

Check failure on line 36 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L36

[Vale.Spelling] Did you really mean 'linux'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'linux'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 36, "column": 35}}}, "severity": "ERROR"}

```bash
limactl shell debian-12
```
```bash
limactl shell debian-12
```

7. Now you are in the linux shell of the debian instance. Now, run the following command to go the `Users` into your directory
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)

Check failure on line 42 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L42

[Vale.Spelling] Did you really mean 'linux'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'linux'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 42, "column": 23}}}, "severity": "ERROR"}

Check failure on line 42 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L42

[Vale.Spelling] Did you really mean 'debian'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'debian'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 42, "column": 42}}}, "severity": "ERROR"}

```bash
cd /Users
```
```bash
cd /Users/{Username}
```

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)
8. Run the following command to install Keploy

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

9. Run the following command to install Keploy
9. Run the following command to install Zsh

Check failure on line 55 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L55

[Vale.Spelling] Did you really mean 'Zsh'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zsh'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 55, "column": 41}}}, "severity": "ERROR"}

```bash
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
```
```bash
sudo apt-get -y install zsh
```

10. Run the following command to 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.

Check failure on line 61 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L61

[Vale.Spelling] Did you really mean 'zsh'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'zsh'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 61, "column": 15}}}, "severity": "ERROR"}

Check failure on line 61 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L61

[Vale.Spelling] Did you really mean 'globbing'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'globbing'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 61, "column": 160}}}, "severity": "ERROR"}

```bash
sudo apt-get -y install zsh
```
10. Install Git

**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.
```bash
sudo apt-get -y install git
```

11. Install Git
11. Install 'Oh-my-zsh'

```bash
sudo apt-get -y install git
```
```bash
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
```

12. Install 'Oh-my-zsh'
**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.

Check failure on line 75 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L75

[Vale.Spelling] Did you really mean 'zsh'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'zsh'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 75, "column": 59}}}, "severity": "ERROR"}

```bash
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
```
12. Commands to Install docker

**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.
```bash
sudo apt-get -y update
```

13. Commands to Install docker
```bash
sudo apt-get -y install ca-certificates curl
```

```bash
sudo apt-get -y update
```
```bash
sudo install -m 0755 -d /etc/apt/keyrings
```

```bash
sudo apt-get -y install ca-certificates curl
```
```bash
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
```

```bash
sudo install -m 0755 -d /etc/apt/keyrings
```
```bash
sudo chmod a+r /etc/apt/keyrings/docker.asc
```

```bash
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /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 chmod a+r /etc/apt/keyrings/docker.asc
```
```bash
sudo apt-get -y update
```

```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 install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
```

```bash
sudo apt-get -y update
```
13. Add docker to sudoers

Check failure on line 114 in versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/keploy-explained/mac-linux.md#L114

[Vale.Spelling] Did you really mean 'sudoers'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'sudoers'?", "location": {"path": "versioned_docs/version-2.0.0/keploy-explained/mac-linux.md", "range": {"start": {"line": 114, "column": 19}}}, "severity": "ERROR"}

```bash
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
```
```bash
sudo groupadd docker
```

14. Add docker to sudoers

```bash
sudo groupadd docker
```

```bash
sudo gpasswd -a $USER docker
```
```bash
sudo gpasswd -a $USER docker
```
26 changes: 20 additions & 6 deletions versioned_docs/version-3.0.0/concepts/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Use "keploy [command] --help" for more information about a command.
<details>
<summary>Install using Docker</summary>

### Downloading and running Keploy in Docker
**_Downloading and running Keploy in Docker_**

#### On macOS

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

3. Run the following command to start the Keploy container:
2. Install Keploy

```shell
curl --silent -O -L https://keploy.io/install.sh && source install.sh
```

#### Examples:

**Record:**

```bash
keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60
```

**Test:**

```bash
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"
keploy test --c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --delay 10 --buildDelay 60
```

</details>

<details>
<summary>Downloading and running Keploy in Native</summary>
<summary>Install Natively</summary>

### Downloading and running Keploy in Native
**_Downloading and running Keploy in Native_**

**Prequisites:**

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

> Note: Keploy is not supported on MacOS natively.

### Setting up the Docker Desktop for WSL 2
**_Setting up the Docker Desktop for WSL 2_**

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ 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** | <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) |
| <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 |

Expand Down
Loading
Loading