VirtServer Installation

Applies to VirtServer 3.12.1, last modified on June 17, 2022

VirtServer uses a separate installation package from ReadyAPI. You can install it on Windows, Linux and macOS. The ways to install the product on these operating systems are very similar. There are differences in installing the product on Linux headless (GUIless) machines. This topic provides detailed information on installation steps for both cases.

Before installing

To run VirtServer, your computer must meet certain system requirements.

Also, you will need either a VirtServer trial license or a commercial VirtServer license. To get a license, contact your sales representative or write to

You install a license during the first VirtServer run.

Installing VirtServer With the Installation Wizard (Typical)

Follow these steps:

  1. Download the VirtServer installer for your platform (Windows, Linux or macOS, 32- or 64-bit) from the SmartBear web site.

    Note: If you use Linux, check that the installer has correct permissions and is executable.
  2. Run the downloaded installation package.

  3. Follow the installation wizard instructions:

    • Specify the installation directory.

    • On one of the steps, the wizard will ask you to select additional components to be installed:

      Service virtualization: Installing VirtServer Components

      These components are optional, but may be needed to run some of your tests:

      Component Description
      ReadyAPI VirtServer Service,
      Autostart Server
      These options work on Windows only. ReadyAPI VirtServer Service commands the installation wizard to install VirtServer as a Windows service. This way VirtServer will run even if no user is logged in to the computer where it is installed.

      Autostart Service means that the operating system will run this service automatically upon startup. Note, however, that if you select this option, the first run of the server may result in an error: to run VirtServer you have to create a user on it first. See Run VirtServer as Service for details.

      JDBC drivers The JDBC driver for the SQL Server database. You can download it at any time later from the MSDN web site.
      Install this driver if your virtual services are using data sources connected to databases. If they use other databases, you will have to install database drivers manually.
  4. After selecting the desired components, click Next to finish the installation.

  5. The last page of the wizard has the Send usage statistics check box. Select this check box if you want to help us find out on what features to focus our development efforts: the check box will let VirtServer know that you agree to provide anonymous data on using the product.

    Tip: You can disable collection of usage statistics later by opening the <User folder>\.readyapi\readyapi‑settings.xml file and changing the value of the UISettings@disable_analytics property to true.

After the installation is over, you may need to perform some additional actions. See below.

After Installation Is Over

After the installation is over, run VirtServer, create a user on it and activate the VirtServer license. These actions are rather simple. Just follow the instructions you will see on the screen.

After installing VirtServer, you may want to replace the SSL certificates it uses or change the VirtServer port number.

VirtServer stores all the information (added virtual services, users, and so on) in a database file. We recommend that you periodically back up that database file.

How to schedule creating a backup
  1. Create a .bat script file that copies the database file:

    copy /Y %HOMEPATH%\.readyapi\virt-server\virt-server.h2.h2.db <Path to the backup folder>

  2. Open Task Scheduler and click Create Basic Task from the right toolbar:

    Creating scheduled task for backing up VirtServer database file

    Click the image to enlarge it.

  3. In the subsequent dialog, specify the name and description of the task. Click Next.

  4. At the Trigger step, specify when you want to back up the database. For example, to back it up once a week, select Weekly and select a day on which you want to copy the file:

    Selecting a trigger for backing up VirtServer database file

    Click the image to enlarge it.

  5. At the Action step, select Start a program and click Next.

  6. At the next step, in the Program/Script field, specify the path to the created script. Click Next:

    Selecting a script file that backs up VirtServer database file

    Click the image to enlarge it.

  1. Create an .sh script file that copies the database file:

    cp ~/.readyapi/virt-server/virt-server.h2.h2.db <Path to the backup file>
  2. Open the terminal and enter the following command:

    crontab -e

    It opens the text editor where you can schedule a task.

  3. At the end of the file, specify the line that commands cron to execute the created script. For example, to perform a backup each Friday, you could specify the following line:

    0 0 * * 5 <Path to your script>

    To learn more about the cron syntax, you can see the Ubuntu documentation.

Installing on Headless Machines

  1. Download the VirtServer installer from the SmartBear web site.

  2. Make sure the installer has appropriate permissions for execution.

  3. Run the installer with the -c argument in its command line. Here is an example for running a 64-bit installer of VirtServer

    <> -c
    Note: On Windows computers, use the following command:

    start /wait <> -c

    The installer will unpack files and then will continue the installation in the command-line mode.

  4. The installer will ask you to perform the same actions that you perform in the GUI installer: specify the installation folder, choose the components to be installed, and so on. Follow the instructions you will see on the screen.

  5. After the installation is over, run VirtServer, create a user, and activate the license (see above).

An alternative approach is to download the VirtServer.tag.gz archive and extract files from it manually. However, in this case, you will have to install JDBC drivers, Java and other components manually, as well.

See Also

User Tasks

Highlight search results