Deploy and configure (Version 25.1.0)

Versions

The following versions are recommended for VidyoInsights:

Product	Version
VidyoPortal and VidyoRouter	24.3.1
VidyoGateway	24.2.1
VidyoConnect for Desktop	24.1.0
VidyoConnect for WebRTC	24.1.0
VidyoConnect for Mobile	25.1.0
VidyoConnect Room	24.2.0

Prerequisites

These are the requirements to set up VidyoInsights:

• A Linux-based machine. For the purposes of this guide, the examples are from an Ubuntu 22.04 Server installation.
• Docker installed on the Linux machine. You can find instructions for installing Docker on Ubuntu 22.04 at https://docs.docker.com/engine/install/ubuntu/

Note The installation and setup of the base OS and Docker is outside the scope of this document.

Note To complete the VidyoInsights installation process, the server must have outbound Internet access. This is needed to download the relevant Docker images from DockerHub.

• TLS/SSL Certificates for your VidyoInsights URL. You will need:
• Private Certificate in PEM format
• Public Certificate in PEM format
• CA Chain in PEM format
• DNS Record for your VidyoInsights URL
• VidyoPortal CDR Access information
• CDR Access URL
• CDR Access Username
• CDR Access Password

Note Firewall rules may need to be adjusted and/or added to allow access from the VidyoInsights server to the VidyoPortal over port 3306. This is meant to be internally accessible only. It is generally recommended to co-locate the VidyoInsights server with the VidyoPortal; however, this is not a strict requirement once the appropriate firewall and access controls are in place.

• Unique JWT Keys (in PEM format). You must generate these keys. For information on how to do so, go to https://docs.mia-platform.eu/docs/runtime_suite/client-credentials/jwt_keys.
• The vidyoinsights_25.1.0.zip package (obtained from Vidyo).

Configuration

Unzip the vidyoinsights_docker_compose.zip package. The following directories and files should be present:

Certificates

1. Edit/replace the vidyoinsights.key file with your TLS/SSL certificates private key for your VidyoInsights FQDN.
   
2. Edit/replace the vidyoinsights.crt file with your TLS/SSL certificates public certificate for your VidyoInsights FQDN. If necessary, you can also include the CA certificate chain.

Caution Do not change the names of the private and public key files: vidyoinsights.key vidyoinsights.crt Only the content of the files should be updated.

Environment - userconfig.env

You will need to update the following parameters in this file:

1. SERVER_IP: This is the VidyoInsights server FQDN. This FQDN must match your certificate.

Example: vidyoinsights.example.com

2. DEFAULT_SUPER_ADMIN_PASSWORD: This is the default “super” password for your VidyoInsights deployment. This password should be changed after deployment.

Example: VidyoInsights123!

3. PUBLIC_SECRET: This is a random seed secret for generating hashes within the cluster. This should be a randomly generated string unique to your deployment.

Example: A_Random_String_1234

4. INFLUXDB_USER_PASSWORD: This is the VidyoInsights Agent password that is configured on your infrastructure components via the System Console.

Example: influxdb_agent_password _1234

5. INFLUXDB_ADMIN_USER: This is an internally used credential that is used as part of the deployment process. It is not externally used. This should not be changed from the default “admin” user.

Example: admin

6. INFLUXDB_ADMIN_PASSWORD: This is an internally used credential that is used as part of the deployment process. It is not externally used. Enter a randomly generated password for deployment.

Example: influx_db_deployment_password _1234

7. MYSQL_HOST: This is your VidyoPortal FQDN. This is the server that hosts your CDR database.

Example: vidyoportal.example.com

8. MYSQL_PASSWORD: This is your CDR Access Password to your VidyoPortal. For more information on how to enable and configure CDR access, see Configure the CDR database.

Example: cdraccesspassword123!

Here is an example of a configuration file with the above examples configured:

jwtRS256 private and public key

The deployment package comes with a default JWT public and private key.

• jwtRS256.key
• jwtRS256.key.pub

It is highly recommended that you generate your own unique pair (in PEM format).

For more information on how to generate these keys, see https://docs.mia-platform.eu/docs/runtime_suite/client-credentials/jwt_keys.

Caution Do not change the names of the private and public key files: jwtRS256.key jwtRS256.key.pub Only the content of the files should be updated.

Docker Compose Deployment

Once you have copied your deployment package to your Docker server, go to the appropriate folder on your file system and run the Docker compose deployment:

This command will first download the relevant docker images from Docker Hub (pull) and then create and configure the containers.

Below is an example of the output of this command:

Shutting down VidyoInsights

Run this command in the same directory as your docker-compose.yml:

VidyoInsights Agent Configuration

To configure the VidyoInsights agent on your VidyoPortal and VidyoRouter:

1. Select E. VidyoInsights Agent Configuration.
   
2. Select Y to change the settings.
   
3. In the Server URL field, enter the VidyoInsights FQDN (URL).
   
4. In the Access User ID field, leave telegraf.
   
5. In the Access User Password field, enter the VidyoInsights Agent password.
   
6. Enter Y to save and apply the configuration.
   

VidyoPortal Tenant Configuration

Add the Custom Parameters to your tenant. You must add these to each tenant in the system for reporting endpoint statistics to VidyoInsights.

1. Log into the Tenant Admin.
2. Navigate to Settings > Feature Settings > Custom Parameters.
3. If Custom Parameters is not enabled, select the checkbox to enable it.
4. Add the following Custom Parameters. When doing so, replace the vidyoinsights.example.com FQDN below with the FQDN of your VidyoInsights server.
5. Click Save.

Note The values below are case-sensitive. Please enter them with the specified case notation.

Auth Type	Key	Value
Registered	insightServerUrl	https://vidyoinsights.example.com/loki/loki/api/v1/push
Unregistered	insightServerUrl	https://vidyoinsights.example.com/loki/loki/api/v1/push

VidyoRouter Configuration

In addition to the VidyoInsights Agent configuration via the System Console, you must also set up the VidyoRouter local configuration. In order to make these configuration changes, you must work with a Vidyo Support representative to add the appropriate configuration changes. (In a future version, this will be available via an exposed configuration option.)

To configure the VidyoRouter:

1. Obtain vidyoadmin access to the VidyoRouter.
2. Edit this configuration file: /opt/vidyo/vidyorouter2/localvrconfig
3. Add the following entries to the localvrconfig file:

ConferenceParticipantStatisticsEnable=y

ConferenceParticipantStatisticsRate=10

ConferenceParticipantStatisticsPushAPI=

https://vidyoinsights.example.com/loki/loki/api/v1/push

ConferenceParticipantStatisticsPushGrouping=40

How to get VidyoInsights logs

Option 1

Use docker compose logs (quick and simple).

Run this command in the same directory as your docker-compose.yml:

This will:

• Capture logs from all services.
• Include timestamps.
• Strip color codes (so it's easier to read).

Then you can send all-container-logs.txt to technical support.

Option 2

Continuously stream logs to a file.

If the issue is ongoing and you want to capture logs over time:

Use Ctrl+C to stop when you're ready to send the file.