From a8f529c9d413f737b7ab9ab1d3ca21d09b2acedf Mon Sep 17 00:00:00 2001 From: TvisharajiK Date: Sun, 29 Sep 2024 23:22:45 +0530 Subject: [PATCH] chore: linux natively (#455) Co-authored-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com> Co-authored-by: Neha Gupta --- .../version-2.0.0/concepts/installation.md | 107 ----------------- .../concepts/platform-requirements.md | 2 +- .../keploy-explained/mac-linux.md | 109 ++++++++++++++++++ .../version-2.0.0-sidebars.json | 3 +- 4 files changed, 112 insertions(+), 109 deletions(-) create mode 100644 versioned_docs/version-2.0.0/keploy-explained/mac-linux.md diff --git a/versioned_docs/version-2.0.0/concepts/installation.md b/versioned_docs/version-2.0.0/concepts/installation.md index a8a9365ce..5f924f43b 100644 --- a/versioned_docs/version-2.0.0/concepts/installation.md +++ b/versioned_docs/version-2.0.0/concepts/installation.md @@ -93,113 +93,6 @@ alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-networ -
- -Running Keploy Natively on MacOS by setting up a linux env - -### Downloading and running Keploy in Native using Debian on MacOS - -1. Open the terminal Session. -2. Run the following command - -```bash -limactl show-ssh --format=config debian-12 & add it to its ssh config -``` - -3. Open a remote window on your code editor -4. Click on connect to host -5. Now select the configured SSH as "lima-debian" -6. Once you are in the terminal run the following commands to go into your directory - -```bash -cd /Users -``` - -```bash -cd /{Username} -``` - -7. Run the following command to install Keploy - -```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 -``` - -8. Run the following command to install Zsh - -```bash -sudo apt-get -y 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. - -9. Install Git - -```bash -sudo apt-get -y install git -``` - -10. Install 'Oh-my-zsh' - -```bash -sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)" -``` - -**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. - -11. Commands to Install docker - -```bash -sudo apt-get -y update -``` - -```bash -sudo apt-get -y install ca-certificates curl -``` - -```bash -sudo install -m 0755 -d /etc/apt/keyrings -``` - -```bash -sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc -``` - -```bash -sudo chmod a+r /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 apt-get -y update -``` - -```bash -sudo apt-get -y update -``` - -```bash -sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -``` - -12. Add docker to sudoers - -```bash -sudo groupadd docker -``` - -```bash -sudo gpasswd -a $USER docker -``` - -
Downloading and running Keploy in Native diff --git a/versioned_docs/version-2.0.0/concepts/platform-requirements.md b/versioned_docs/version-2.0.0/concepts/platform-requirements.md index c19e0ab32..e128ccc69 100644 --- a/versioned_docs/version-2.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-2.0.0/concepts/platform-requirements.md @@ -27,7 +27,7 @@ Linux: | Operating System | Without Docker | Docker Installation | Prerequisites | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| MacOS **MacOS** | Not Supported | Supported | Docker Desktop version must be 4.25.2 or above | +| MacOS **MacOS** | Not Supported | Supported | - Docker Desktop version must be 4.25.2 or above
- For running Keploy on MacOS natively, refer to [Guide](/keploy-explained/mac-linux.md) | | Windows **Windows** | Supported | Supported | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 | | Linux **Linux** | Supported | Supported | Linux kernel 5.15 or higher | diff --git a/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md new file mode 100644 index 000000000..71e8d1038 --- /dev/null +++ b/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md @@ -0,0 +1,109 @@ +--- +id: mac-linux +title: "Running Keploy Natively on MacOS by setting up a linux env" +sidebar_label: Keploy on MacOS native +--- + +# Running Keploy Natively on MacOS by setting up a linux env + +### Downloading and running Keploy in Native using Debian on MacOS + +1. Open the terminal Session. +2. Run the following command + +```bash +limactl show-ssh --format=config debian-12 & add it to its ssh config +``` + +3. Open a remote window on your code editor +4. Click on connect to host +5. Now select the configured SSH as "lima-debian" +6. Once you are in the terminal run the following commands to go into your directory + +```bash +cd /Users +``` + +```bash +cd /{Username} +``` + +7. Run the following command to install Keploy + +```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 +``` + +8. Run the following command to install Zsh + +```bash +sudo apt-get -y 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. + +9. Install Git + +```bash +sudo apt-get -y install git +``` + +10. Install 'Oh-my-zsh' + +```bash +sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)" +``` + +**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. + +11. Commands to Install docker + +```bash +sudo apt-get -y update +``` + +```bash +sudo apt-get -y install ca-certificates curl +``` + +```bash +sudo install -m 0755 -d /etc/apt/keyrings +``` + +```bash +sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc +``` + +```bash +sudo chmod a+r /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 apt-get -y update +``` + +```bash +sudo apt-get -y update +``` + +```bash +sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin +``` + +12. Add docker to sudoers + +```bash +sudo groupadd docker +``` + +```bash +sudo gpasswd -a $USER docker +``` diff --git a/versioned_sidebars/version-2.0.0-sidebars.json b/versioned_sidebars/version-2.0.0-sidebars.json index 85cdb0565..9194149c5 100644 --- a/versioned_sidebars/version-2.0.0-sidebars.json +++ b/versioned_sidebars/version-2.0.0-sidebars.json @@ -171,7 +171,8 @@ "keploy-explained/contribution-guide", "keploy-explained/docs-dev-guide", "keploy-explained/debugger-guide", - "keploy-explained/testing-guide" + "keploy-explained/testing-guide", + "keploy-explained/mac-linux" ] } ]