Server User Guide
Version v1.6.0

Installation and Upgrade

Before installing Alyvix, first check that your setup meets the system requirements.


System Requirements

Note

Alyvix assumes that you have one virtual or physical machine exclusively dedicated to running Alyvix test cases.

You should check that your designated machine and the account on that machine meet the following requirements before you install Alyvix:

Minimum

Recommended

Operating System

Windows 10 (64-bit) Pro or Enterprise

Windows Server 2016, 2019 or 2022 (English language)

(32-bit versions of Windows are not compatible with Alyvix)

Processor

2 CPUs

2 CPUs base + 2 CPUs per session

Memory

4GB RAM

4GB RAM base + 4GB RAM per session

Graphics

24-bit RGB or 32-bit RGBA screen color depth

Remote Desktop

Users defined on Alyvix Server must have RDP access (through RDC mstsc.exe) to the machine itself (e.g. the user must be a Remote Desktop User, and the firewall must not be set to block local RDC)

1 session only: No Windows Terminal Server available; 1 test case executed at a time

Multiple sessions in parallel: Windows Terminal Server permits multiple test cases to run at once

Application Permissions

Users defined on Alyvix Server must have the proper permissions to run and interact with the application interface being monitored

Networks

Alyvix Server must be reachable from an external browser


Versions

Alyvix Server Version

Required Alyvix Version

PostgreSQL Version

Alyvix Server 1.6.0

Alyvix 3.2.3

12.x

Alyvix Server 1.5.0

Alyvix 3.2.0

12.x


Installation Steps

The following steps will install Alyvix Server on your machine:

  1. Install Python

    Follow the same instructions as for Alyvix

  2. Install Alyvix

    Follow the Alyvix installation instructions

  3. Install PostgreSQL 12.x

    Download and run the PostgreSQL installer

  4. Install Alyvix Server

    • Get the software package

    • Run the setup.exe installer

    • Set the database password as follows:

      • Open the file C:\Program Files\Alyvix\Alyvix Server\config.json

      • Set your own password in this line:

        "database":{.. "password": "<your_password>", ..}

  5. Install your HTTPS certificate

    Save your files as follows:

    • Go to the folder C:\Program Files\Alyvix\Alyvix Server\cert\

    • Save cert.crt as an HTTPS certificate recognized by your CA

    • Save cert.key as its (unprotected) password

    Note that the private key is all you need, you should not be asked for an additional password.

  6. Run Alyvix Service within Windows Services


Upgrading

The following steps will upgrade Alyvix Server to the latest version on your machine:

  1. Uninstall Alyvix Server

    • Back up your Alyvix Server configuration file: C:\Program Files\Alyvix\Alyvix Server\config.json

    • Back up your Alyvix Server HTTPS certificate: C:\Program Files\Alyvix\Alyvix Server\cert\

    • Stop Alyvix Server: Windows Services > Alyvix Service > Stop

    • Close all Alyvix client windows (where appropriate)

    • Uninstall Alyvix Server: Windows Control Panel > Programs and Features > Alyvix Server > Uninstall

    • Remove residual Alyvix Server files (where appropriate): C:\Program Files\Alyvix\Alyvix Server\

    • Remove old Alyvix Client scheduled tasks: Windows Task Scheduler > alyvix_client<..> > delete

  2. Upgrade Alyvix

    Follow the instructions here

  3. Install the new Alyvix Server

    • Run the Alyvix Server Installer (setup.exe) found in the Alyvix Server package

    • Set a database password (or restore the backup file): C:\Program Files\Alyvix\Alyvix Server\config.json > “password”: “<your_password>”

    • Install your HTTPS certificate (or restore the backup files): Save the cert.crt and cert.key files in C:\Program Files\Alyvix\Alyvix Server\cert\

  4. Run Alyvix Server

    • Start the Alyvix Service: Windows Services > Alyvix Service > start

    • Sign out of the current session