Skip to content

Commit a8f529c

Browse files
TvisharajiKSonichigonehagup
authored and
actions-user
committed
chore: linux natively (#455)
Co-authored-by: Animesh Pathak <[email protected]> Co-authored-by: Neha Gupta <[email protected]>
1 parent a7f98f4 commit a8f529c

File tree

4 files changed

+112
-109
lines changed

4 files changed

+112
-109
lines changed

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

Lines changed: 0 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -93,113 +93,6 @@ alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-networ
9393

9494
</details>
9595

96-
<details>
97-
98-
<summary>Running Keploy Natively on MacOS by setting up a linux env</summary>
99-
100-
### Downloading and running Keploy in Native using Debian on MacOS
101-
102-
1. Open the terminal Session.
103-
2. Run the following command
104-
105-
```bash
106-
limactl show-ssh --format=config debian-12 & add it to its ssh config
107-
```
108-
109-
3. Open a remote window on your code editor
110-
4. Click on connect to host
111-
5. Now select the configured SSH as "lima-debian"
112-
6. Once you are in the terminal run the following commands to go into your directory
113-
114-
```bash
115-
cd /Users
116-
```
117-
118-
```bash
119-
cd /{Username}
120-
```
121-
122-
7. Run the following command to install Keploy
123-
124-
```bash
125-
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
126-
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
127-
```
128-
129-
8. Run the following command to install Zsh
130-
131-
```bash
132-
sudo apt-get -y install zsh
133-
```
134-
135-
**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.
136-
137-
9. Install Git
138-
139-
```bash
140-
sudo apt-get -y install git
141-
```
142-
143-
10. Install 'Oh-my-zsh'
144-
145-
```bash
146-
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
147-
```
148-
149-
**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.
150-
151-
11. Commands to Install docker
152-
153-
```bash
154-
sudo apt-get -y update
155-
```
156-
157-
```bash
158-
sudo apt-get -y install ca-certificates curl
159-
```
160-
161-
```bash
162-
sudo install -m 0755 -d /etc/apt/keyrings
163-
```
164-
165-
```bash
166-
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
167-
```
168-
169-
```bash
170-
sudo chmod a+r /etc/apt/keyrings/docker.asc
171-
```
172-
173-
```bash
174-
echo \
175-
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
176-
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
177-
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
178-
```
179-
180-
```bash
181-
sudo apt-get -y update
182-
```
183-
184-
```bash
185-
sudo apt-get -y update
186-
```
187-
188-
```bash
189-
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
190-
```
191-
192-
12. Add docker to sudoers
193-
194-
```bash
195-
sudo groupadd docker
196-
```
197-
198-
```bash
199-
sudo gpasswd -a $USER docker
200-
```
201-
202-
</details>
20396
<details>
20497
<summary>Downloading and running Keploy in Native</summary>
20598

‎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 |
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) |
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: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
id: mac-linux
3+
title: "Running Keploy Natively on MacOS by setting up a linux env"
4+
sidebar_label: Keploy on MacOS native
5+
---
6+
7+
# Running Keploy Natively on MacOS by setting up a linux env
8+
9+
### Downloading and running Keploy in Native using Debian on MacOS
10+
11+
1. Open the terminal Session.
12+
2. Run the following command
13+
14+
```bash
15+
limactl show-ssh --format=config debian-12 & add it to its ssh config
16+
```
17+
18+
3. Open a remote window on your code editor
19+
4. Click on connect to host
20+
5. Now select the configured SSH as "lima-debian"
21+
6. Once you are in the terminal run the following commands to go into your directory
22+
23+
```bash
24+
cd /Users
25+
```
26+
27+
```bash
28+
cd /{Username}
29+
```
30+
31+
7. Run the following command to install Keploy
32+
33+
```bash
34+
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
35+
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
36+
```
37+
38+
8. Run the following command to install Zsh
39+
40+
```bash
41+
sudo apt-get -y install zsh
42+
```
43+
44+
**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.
45+
46+
9. Install Git
47+
48+
```bash
49+
sudo apt-get -y install git
50+
```
51+
52+
10. Install 'Oh-my-zsh'
53+
54+
```bash
55+
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
56+
```
57+
58+
**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.
59+
60+
11. Commands to Install docker
61+
62+
```bash
63+
sudo apt-get -y update
64+
```
65+
66+
```bash
67+
sudo apt-get -y install ca-certificates curl
68+
```
69+
70+
```bash
71+
sudo install -m 0755 -d /etc/apt/keyrings
72+
```
73+
74+
```bash
75+
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
76+
```
77+
78+
```bash
79+
sudo chmod a+r /etc/apt/keyrings/docker.asc
80+
```
81+
82+
```bash
83+
echo \
84+
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
85+
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
86+
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
87+
```
88+
89+
```bash
90+
sudo apt-get -y update
91+
```
92+
93+
```bash
94+
sudo apt-get -y update
95+
```
96+
97+
```bash
98+
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
99+
```
100+
101+
12. Add docker to sudoers
102+
103+
```bash
104+
sudo groupadd docker
105+
```
106+
107+
```bash
108+
sudo gpasswd -a $USER docker
109+
```

‎versioned_sidebars/version-2.0.0-sidebars.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,8 @@
171171
"keploy-explained/contribution-guide",
172172
"keploy-explained/docs-dev-guide",
173173
"keploy-explained/debugger-guide",
174-
"keploy-explained/testing-guide"
174+
"keploy-explained/testing-guide",
175+
"keploy-explained/mac-linux"
175176
]
176177
}
177178
]

0 commit comments

Comments
 (0)