Installing and Configuring T-VREX
Click here to see this page in full context

 

Installing and Configuring T-VREX

Checking system prerequisites

Before installing T-VREX, check the following system prerequisites:

  1. Verify that the System Requirements are met.   
  2. Verify that Docker and Docker Compose are installed, configured, and ready to use.
  3. To install T-VREX, the user must have read and write permission on the installation directory and execute permission for the Docker commands.

Installation procedure

From HCL License Portal download T-VREX Technical Preview installation package: HWA_TVREX_TP23-03.tgz.

Extract the package content into <BUILD_DIR>, a directory of your choice using one of the extraction tools available on your system or downloadable from the Internet. The tool you use must be able to keep the file permissions on the extracted files.

 

You can install T_VREX by using the tvrex.sh script in two different ways:

 

Run tvrex.sh --help to get usage details about the installation script.

 

Installing with a configuration file

  1. Locate the <BUILD_DIR>/configurations/environment configuration file
  2. Open the file and specify the following configuration values:

 

Parameter Description Default Required
TVREX_PORT T-VREX Server port

3000

Y
DWC_HOST DWC Host HTTPS connection URL

localhost:9443

Y
CLARA_HOST Clara Host connection URL (Example: <clara_machine_ip:clara_machine_port>)

 

 
CLARA_PORT Clara port                           N
STUN_SERVER STUN Server for voice support. Suggested value: stun:stun.l.google.com:19302                           N

 

  1. From the <BUILD_DIR>/configurations folder, install T-VREX by running the command: ./tvrex.sh --install

 

 

Installing with user interaction

  1. To install T-VREX with user interaction, from the <BUILD_DIR>/configurations folder, run ./tvrex.sh -i

  2. As the installation script starts, it requires you to enter the configuration parameters. For reference, see the table above.

 

Post installation steps

When the installation is complete, you can access T_VREX User Interface at the following link: https://<hostname:port>/

where hostname and port are the values provided for T-VREX server during the installation.


In T-VREX login panel enter the same credentials you use to login to the Dynamic Workload Console.

 

When the installation is complete, if you need to update the value of the environment variables in the configuration file, you must restart T-VREX container.

To restart T-VREX container, run the following commands from the <BUILD_DIR>/configurations folder:
./tvrex.sh --down
./tvrex.sh --up

 

For custom SSL certificates, see Customizing SSL certificates.

 

To take advantage of HCL Clara Virtual Assistant in T-VREX, see Enabling Clara in T-VREX.

 

To enable multi-user mode, see Enabling multiple users.

 

 

Reinstalling T-VREX

To reinstall T-VREX, you must remove the current container by running the command:
./tvrex.sh –down
Then, you can reinstall T-VREX.

 

 

 

tvrex.sh command usage

Use ./tvrex.sh script to install T-VREX, manage T-VREX docker containers, and set debugging options.

 

./tvrex.sh [-p <tvrex port>, -ch <clara host>, -dbt <database type>, -dbt <database host>, -wah <tdwc host>]

 

-p <tvrex port> : T-VREX Server port <defaults to 3000>
-ch <clara host> : Clara websocket connection url <default not set>
-dbt <database type> : Database type : elasticsearch | inMemory <defaults to inMemory>
-dbu <database host> : Database connection url <defaults to localhost:9200>
-wah <dwc host> : Workload Automation DWC connection url <defaults to localhost:9443>
-i : Starts T-VREX installation in interactive mode

--install : Installs T-VREX with existing configuration
--start : Starts T-VREX container
--stop : Stops T-VREX container
--up : Creates T-VREX container
--down : Deletes T-VREX container

--update-log-level [-p for persistance] : Updates log configuration from environment file

--error-log-level [-p for persistance] : Updates log configuration to ERROR level

--info-log-level [-p for persistance] : Updates log configuration to INFO level

--trace-log-level [-p for persistance] : Updates log configuration to TRACE level

 

 

 

 

 

 

Leave feedback