Installation and Upgrade
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 |
|
|
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) |
||
|
2 CPUs |
2 CPUs base + 2 CPUs per session |
|
4GB RAM |
4GB RAM base + 4GB RAM per session |
|
24-bit RGB or 32-bit RGBA screen color depth |
|
|
Users defined on Alyvix Service 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 allows multiple test cases to run at once |
|
|
Users defined on Alyvix Service must have the proper permissions to run and interact with the application interface being monitored |
Versions¶
Alyvix Service Version |
Required Alyvix Version |
PostgreSQL Version |
Alyvix Service 2.0.0 |
Installation Steps¶
The following steps will install Alyvix Service on your machine:
Install Python
Follow the same instructions as for Alyvix
Install Alyvix
Follow the Alyvix installation instructions
Install PostgreSQL 12.x
Download and run the PostgreSQL installer
Install Alyvix Service
Run the
setup.exe
installerSet the database password as follows:
Open the file
C:\Program Files\Alyvix\Alyvix Service\config.json
in administrator modeSet your own password in this line:
"database":{.. "password": "<your_password>", ..}
Install your HTTPS certificate
Save your files as follows:
Create the folder
C:\Program Files\Alyvix\Alyvix Service\cert\
Save
cert.crt
as an HTTPS certificate recognized by your CASave
cert.key
as its (unprotected) password
Note that the private key is all you need, you should not be asked for an additional password.
Copy the JSON Web Token (JWT), which Alyvix currently implements for authentication purposes, from your monitoring system.
Create the folder
C:\ProgramData\Alyvix\certs\jwt\
Copy the JWT certificate file from your monitoring system into the folder above, renaming it to
public.pem
.
Run Alyvix Service within Windows Services at Windows Services > Alyvix Service > start
Upgrading¶
The following steps will upgrade Alyvix Service to the latest version on your machine:
Uninstall Alyvix Service
Back up your Alyvix Service configuration file:
C:\Program Files\Alyvix\Alyvix Service\config.json
Back up your Alyvix Service HTTPS certificate:
C:\Program Files\Alyvix\Alyvix Service\cert\
Back up your Alyvix Service JSON Web Token (JWT) certificate:
C:\ProgramData\Alyvix\certs\jwt\
Stop Alyvix Service: Windows Services > Alyvix Service > Stop
Close all Alyvix client windows (where appropriate)
Uninstall Alyvix Service: Windows Control Panel > Programs and Features > Alyvix Service > Uninstall
Remove residual Alyvix Service files (where appropriate):
C:\Program Files\Alyvix\Alyvix Service\
Remove old Alyvix Client scheduled tasks: Windows Task Scheduler > alyvix_client<..> > delete
Upgrade Alyvix
Follow the instructions here
Install the new Alyvix Service
Run the Alyvix Service Installer (
setup.exe
) found in the Alyvix Service packageSet the database password by editing the file
C:\Program Files\Alyvix\Alyvix Service\config.json
in administrator mode (or by restoring the backup file):
"database":{.. "password": "<your_password>", ..}
Install your HTTPS certificate (or restore the backup files): Save the
cert.crt
andcert.key
files inC:\Program Files\Alyvix\Alyvix Service\cert\
Install your JSON Web Token (JWT) certificate (or resture the backup file): Save the
public.pem
file inC:\ProgramData\Alyvix\certs\jwt\
Run Alyvix Service
Start the Alyvix Service: Windows Services > Alyvix Service > start
Sign out of the current session