Knowledge Base

Introduction

The Installation documentation describes the steps to install NoldusHub. It contains the following chapters:

• Specifications with requirements for the PCs in the network and the network itself.
• Connections with an example of a setup with two participant stations.
• Guides with the installation procedures.
• A Reference section with additional information.

Installation Steps

Installation of NoldusHub requires the following steps:

1. Verify whether system configuration is still in line with requirements. For this, the Installation Readiness Tool should be used (see also the installation procedure flow diagram at the bottom of this page).
2. Set up a secure connection for your subdomain. Create a secure connection within your company domain, so that NoldusHub opens without security warnings.
3. Install NoldusHub on the server.
4. Set up NTP Client on the participant PCs.
5. Set up screen and camera sharing on participant PCs. Carry out this procedure on every participant PC, so that the screen content and camera stream is visible in NoldusHub.
6. Prepare participant PCs for eye tracking. If you have eye trackers, carry out this procedure on every participant PC that you want to use for eye tracking.
7. Prepare participant PCs for biosensors. If you have Shimmer devices, carry out this procedure on every participant PC that you want to use for biosensor data collection.
8. Start and activate NoldusHub.
9. Perform optional settings:
   1. Change default location of saved videos.
   2. Windows Defender folder exclusions.
   3. Automatic data export after session recording.
   4. NTP syncing of multiple servers.
   5. Modifying Windows update scheduling to prevent performance drops.

Upgrade NoldusHub

Aim: To upgrade an older NoldusHub version to NoldusHub 1.7. This description presumes an existing and running NoldusHub instance on the server computer.

Server

• The server should meet the requirements described in the Specifications.
• To verify whether system configuration is still in line with requirements, the Installation Readiness Tool should be used first.
• Verify whether the SSL certificate is valid for a sufficiently long period, and whether it is still configured correctly. For that, the certificate check tool is made available on MyNoldus.
• NoldusHub 1.6 or later versions use only secure N-Linx (RabbitMQ) communication:
  • Older NoldusHub versions used port 5672.
  • Since NoldusHub 1.6, port 5671 is used for communication.
  • Customer IT should open port 5671 for incoming communication before the NoldusHub upgrade process and, at the end of the process, they can close the port.

Participant PCs

• The participant PCs should meet the requirements described in the Specifications.
• NoldusHub 1.6 or later versions use only secure N-Linx (RabbitMQ) communication:
  • Older NoldusHub versions used port 5672.
  • Since NoldusHub 1.6, port 5671 is used for communication.
  • Customer IT should open port 5671 for outgoing communication to the server before the NoldusHub upgrade process and, at the end of the process, they can close port 5672.

Step 1: Backup and Upgrade the Server PC

1. Stop the running NoldusHub instance:
   • Open the folder C:\Program Files\Noldus\NoldusHub in File Explorer.
   • Run the batch file StopNoldusHub.
   • Check if there is a running docker container (with command docker ps -a).
2. Backup the current NoldusHub files:
   • The backup script saves the files to D:/NoldusHubBackup/ folder by default. Check if the D: drive exists and has enough free space for the backup.
   • If the D: drive is not suitable, change this in Backup-NoldusHub.ps1 accordingly (at variable $customer_backup_folder_root).
   • Run the batch file BackupNoldusHub.
3. Keep the previous version installation and control files:
   • Rename the C:\Program Files\Noldus\NoldusHub folder (e.g. to C:\Program Files\Noldus\NoldusHub_1.4).
4. Install the NoldusHub 1.7 files on the server:
   • Open the DockerDeployment folder on the NoldusHub 1.7 installation stick and double-click the batch file InstallNoldusHub.
   • When a window opens with the request to click any key to continue, press a key on your keyboard.
   • When a question appears about whether you want the software to make changes to your computer, click Yes.
   • When a question appears about whether you want to run this software, type A.
   • Replace the .env file with the previous, working one, or update it manually. Overwrite C:\Program Files\Noldus\NoldusHub\.env from the renamed folder (e.g. with C:\Program Files\Noldus\NoldusHub_1.4\.env).
5. Download the docker images:
   • Make sure the antivirus software is disabled at this point.
   • Open the folder C:\Program Files\Noldus\NoldusHub and double-click the batch file UpdateNoldusHub. This will download the docker images. When a window opens with the request to click any key to continue, press a key on your keyboard.
   • Check the output message. In some cases, the antivirus software blocks the download. Run the UpdateNoldusHub batch file again if required.
   • Check the downloaded images with the docker image ls command.
6. Update the number of Video Web Services:
   • Edit the -vws parameter value in the StartNoldusHub batch file if necessary.
   • Check the parameter value in the previous version.
7. Start NoldusHub:
   • Open the folder C:\Program Files\Noldus\NoldusHub and double-click the batch file StartNoldusHub. When a window opens with the request to click any key to continue, press a key on your keyboard.

Step 2: Upgrade Test Participant PCs

1. On the test participant PC, locate the N-Linx Agent icon in the system tray, right-click and select Exit. Make sure the NLinxAgent.exe is not running (check in Task Manager).
2. Uninstall N-Linx Agent.
3. Remove completely the C:\ProgramData\Noldus\N-Linx Agent\ and C:\ProgramData\Noldus\PluginServer\ folders.
4. Copy the N-Linx Agent folder from the NoldusHub 1.7 installation folders to the test participant PCs (e.g. to Desktop).
5. Locate N-Linx Agent Setup.exe and double-click this file to run it.
6. Double-click the N-Linx Agent icon in the system tray.
7. Add the N-Linx Server Address as the NoldusHub server.
   • Only a valid DNS name is accepted with a valid certificate.
   • IP Address cannot be used.
8. Add suitable plugins (for NoldusHub 1.7) in N-Linx Agent. Devices setup is not affected by plugin updates. However, if devices need to be configured again for any reason, this can be done here.

Setup

In general, a NoldusHub setup consists of the following hardware:

• A server that hosts the NoldusHub software.
• One or more participant PCs, each with a USB camera and, optionally, an eye tracker and/or a biosensor device.
• A test leader PC.
• A switch for connecting the server and PCs.
• A router.

This schematic depicts a setup with two participant PCs with the supporting hardware. Other setups are an option as well. NoldusHub supports setups with 1–4 participant stations.

Source: NoldusHub 1.7 Installation Documentation, Noldus Information Technology