diff --git a/versioned_docs/version-2.0.0/concepts/installation.md b/versioned_docs/version-2.0.0/concepts/installation.md index cdd72f03d..fb2bf3837 100644 --- a/versioned_docs/version-2.0.0/concepts/installation.md +++ b/versioned_docs/version-2.0.0/concepts/installation.md @@ -71,7 +71,7 @@ Use "keploy [command] --help" for more information about a command.
Install using Docker -### Downloading and running Keploy in Docker +**Downloading and running Keploy in Docker** #### On macOS @@ -85,10 +85,24 @@ 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 --network keploy-network " --container-name "" --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 --network keploy-network " --delay 10 --buildDelay 60 ```
@@ -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/). 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 e128ccc69..b50de422f 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
- For running Keploy on MacOS natively, refer to [Guide](/keploy-explained/mac-linux.md) | +| 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
| | 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 index 5011b79f2..bf104e6f4 100644 --- a/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md @@ -6,123 +6,117 @@ 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 +**_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 -```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. -```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 -```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) -```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 -```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. -```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. -```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 -```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 + ``` diff --git a/versioned_docs/version-3.0.0/concepts/installation.md b/versioned_docs/version-3.0.0/concepts/installation.md index cdd72f03d..d772fa902 100644 --- a/versioned_docs/version-3.0.0/concepts/installation.md +++ b/versioned_docs/version-3.0.0/concepts/installation.md @@ -71,7 +71,7 @@ Use "keploy [command] --help" for more information about a command.
Install using Docker -### Downloading and running Keploy in Docker +**_Downloading and running Keploy in Docker_** #### On macOS @@ -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 --network keploy-network " --container-name "" --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 --network keploy-network " --delay 10 --buildDelay 60 ```
-Downloading and running Keploy in Native +Install Natively -### Downloading and running Keploy in Native +**_Downloading and running Keploy in Native_** **Prequisites:** @@ -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/). diff --git a/versioned_docs/version-3.0.0/concepts/platform-requirements.md b/versioned_docs/version-3.0.0/concepts/platform-requirements.md index e128ccc69..b50de422f 100644 --- a/versioned_docs/version-3.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-3.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
- For running Keploy on MacOS natively, refer to [Guide](/keploy-explained/mac-linux.md) | +| 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
| | 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-3.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md index 5011b79f2..d11e9c53b 100644 --- a/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md @@ -6,123 +6,127 @@ 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 +**_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 +1. Open the terminal Session. +2. Run the following command. This installs homebrew and makes it easier to manage software and packages on macOS -```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. +3. Now, with the help of homebrew, we would install Lima (Linux Virtual Machine) by running this command. -```bash -brew install lima -``` + ```bash + brew install lima + ``` -4. Create a Debian instance. +4. Create a Debian instance. -```bash -limactl create template://debian-12 -``` + ```bash + limactl create template://debian-12 + ``` -5. Start the instance +5. Start the instance -```bash -limactl start debian-12 -``` + ```bash + limactl start debian-12 + ``` -6. Enter the shell of the running linux instance +6. Enter the shell of the running linux instance -```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) -```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 -```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. -```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. -```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 -```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 gpasswd -a $USER docker + ``` -```bash -sudo groupadd docker -``` + Congratulations! You've successfully set up Keploy natively on MacOS. -```bash -sudo gpasswd -a $USER docker -``` +## What's Next? + +### 🎬 [Start Capturing Testcases](/docs/server/installation/#-capturing-testcases) + +Begin recording your API calls and generating test cases with Keploy. + +#### [Back to Installation Guide](/docs/server/installation/)