Skip to content

Commit 997016e

Browse files
manasmanoharmanasmanohar
authored
chore: update links (#633)
* chore: update links - update mac guide links in table - add docker exmaple commands - fix the heading inside ther summary element getting indexed in the sidebar Signed-off-by: Manas Manohar <[email protected]> * chore: typo Signed-off-by: Manas Manohar <[email protected]> --------- Signed-off-by: Manas Manohar <[email protected]>
1 parent 8d9b8c6 commit 997016e

File tree

6 files changed

+202
-176
lines changed

6 files changed

+202
-176
lines changed

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

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ 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

7676
#### On macOS
7777

@@ -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: 74 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -6,123 +6,117 @@ 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+
9. Run the following command to install Zsh
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+
```bash
58+
sudo apt-get -y install zsh
59+
```
6060

61-
10. Run the following command to install Zsh
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.
6262

63-
```bash
64-
sudo apt-get -y install zsh
65-
```
63+
10. Install Git
6664

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.
65+
```bash
66+
sudo apt-get -y install git
67+
```
6868

69-
11. Install Git
69+
11. Install 'Oh-my-zsh'
7070

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

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

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

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.
79+
```bash
80+
sudo apt-get -y update
81+
```
8282

83-
13. Commands to Install docker
83+
```bash
84+
sudo apt-get -y install ca-certificates curl
85+
```
8486

85-
```bash
86-
sudo apt-get -y update
87-
```
87+
```bash
88+
sudo install -m 0755 -d /etc/apt/keyrings
89+
```
8890

89-
```bash
90-
sudo apt-get -y install ca-certificates curl
91-
```
91+
```bash
92+
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
93+
```
9294

93-
```bash
94-
sudo install -m 0755 -d /etc/apt/keyrings
95-
```
95+
```bash
96+
sudo chmod a+r /etc/apt/keyrings/docker.asc
97+
```
9698

97-
```bash
98-
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
99-
```
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+
```
100105

101-
```bash
102-
sudo chmod a+r /etc/apt/keyrings/docker.asc
103-
```
106+
```bash
107+
sudo apt-get -y update
108+
```
104109

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-
```
110+
```bash
111+
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
112+
```
111113

112-
```bash
113-
sudo apt-get -y update
114-
```
114+
13. Add docker to sudoers
115115

116-
```bash
117-
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
118-
```
116+
```bash
117+
sudo groupadd docker
118+
```
119119

120-
14. Add docker to sudoers
121-
122-
```bash
123-
sudo groupadd docker
124-
```
125-
126-
```bash
127-
sudo gpasswd -a $USER docker
128-
```
120+
```bash
121+
sudo gpasswd -a $USER docker
122+
```

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

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ 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

7676
#### On macOS
7777

@@ -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 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>
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

‎versioned_docs/version-3.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

0 commit comments

Comments
 (0)