Installation
ReadyAPI installs on Windows, Linux, and macOS. Binary installers include a bundled Java Development Kit (JDK) - no separate Java installation is required. Silent and command-line installation options are available for enterprise deployment.
Note
VirtServer and TestEngine have separate installers. See VirtServer Installation and TestEngine Installation.
System requirements
Requirement | Specification |
|---|---|
Operating systems | Windows 10/11, Windows Server 2019/2022; Ubuntu 20.04+, Red Hat Enterprise Linux (RHEL) 8/9, Debian 11/12; macOS 12 Monterey or later. |
Processor | Intel Core i5/i7 (third generation or later) or equivalent AMD processor; 64-bit. |
Memory | 16 GB RAM minimum; at least 1 GB free RAM at startup. |
Java | Adoptium JDK 21 - bundled with the installer. No separate installation is required. |
Display | 1920 x 1080 recommended at 100% scaling. See UI Scaling for lower-resolution configuration. |
License | Trial or commercial license required. Activate via SmartBear ID on first launch. |
For load testing at scale (500 or more virtual users), see System Requirements for Large-Scale Load Tests.
Install on Windows
To install ReadyAPI on Windows, do the following:
Download the Windows installer (.exe) from the ReadyAPI Downloads Center.
Run the installer. If ReadyAPI is already installed, the installer offers an upgrade or a fresh install to a different directory.
Accept the license agreement and select the installation directory.
Click Finish. Optionally, select either Run ReadyAPI or Create a desktop icon.
On first launch, sign in with your SmartBear ID to activate your license.
Install on macOS
To install ReadyAPI on macOS, do the following:
Download the macOS installer (.pkg) from the ReadyAPI Downloads Center.
Open the package and follow the installation wizard.
On first launch, sign in with your SmartBear ID to activate your license.
Install on Linux
Before installing, run the following commands. Missing libraries cause errors on some distributions.
# Ubuntu / Debian sudo apt-get install fontconfig # RHEL 9 (also required for VirtServer on RHEL 9) sudo dnf install freetype
To install ReadyAPI on Linux, do the following:
Download the Linux installer (.sh) for your platform bitness from the ReadyAPI Downloads Center.
Make the installer executable by running the following command:
chmod +x ./ReadyAPI-x64-4.x.x.sh
Run the installer and follow the wizard. On headless machines, add the
-cflag to run in console mode.On first launch, activate your license through SmartBear ID or your access key (for headless and CI/CD use).
Enterprise and automated deployment
Scenario | Approach |
|---|---|
Docker | Use the official SmartBear Docker image. Requires a Floating license. See Run ReadyAPI in Docker. |
Private networks and air-gapped environments | Convert your SmartBear License Management (SLM) license to offline mode through the SmartBear Licensing Portal. Deploy the On-Premises SLM License Server for Floating license management without outbound internet access. See Licensing in Private Networks. |
VM deployments | Floating licenses are required. Fixed (Named) licenses do not support virtual machine or containerized environments. |
Silent install | Run the installer with the |
Update ReadyAPI
To update from within the product, select Help, then Check for Updates.
To update silently, re-run the installer against the existing installation directory. The installer detects the existing version and upgrades it automatically.
Note
TestEngine is not automatically updated when ReadyAPI updates. Update TestEngine separately. See the TestEngine Installation Guide.