Server User Guide
Version v1.5.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 meets the following requirements before you install Alyvix:

Requirements

  • Screen color depth: 24-bit RGB or 32-bit RGBA

  • OS: Windows 64-bit 10 Pro, Server 2012, 2016 or 2019 (32-bit versions of Windows are not compatible with Alyvix)

    • Windows 10 Professional hosts must be reachable from an external browser

  • Hardware (for instance to run 4 sessions, a minimum of 10 CPU and 20GB RAM):

    • Processor: 2 CPUs Base + 2 CPUs per session

    • Memory: 4GB RAM Base + 4GB RAM per session


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.4

    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