Installing HVR on Unix or Linux

Last updated on Sep 13, 2021


This section provides information about the requirements and a step-by-step instruction on how to install HVR on Unix or Linux. The installation procedure described here is applicable (and also same) for installing - HVR as Hub or HVR as remote agent.

Requirements for Unix or Linux

  • Installation of HVR's own protocol can require root permission. HVR's protocol is needed when connecting from the HVR GUI to the hub machine and also when connecting from the hub machine to a remote HVR location. The root permission is needed to edit the inetdxinetd or systemd configuration files. An alternative configuration method for HVR's protocol is to use command Hvrremotelistener instead of inetdxinetd or systemd; this alternative does not necessarily need root permission.
  • Perl module IO::Socket::SSL version 2.007.
    This module is required for sending Hvrmaint notification email using the STARTTLS (option -smtp_starttls).

Install HVR on Unix or Linux

To install HVR on Unix or Linux, perform the following steps as the user which will operate the HVR application:

It is recommended to create a non-root account for installing and operating HVR. We suggest creating a separate user account (e.g, hvruser) for this purpose.

  1. Configure the environment variables HVR_HOMEHVR_CONFIG, and HVR_TMP for your operating system. Each of these environment variables should be pointed to the HVR installation directories - hvr_homehvr_config, and hvr_tmp.

    $ export HVR_HOME=/home/hvruser/hvr/hvr_home
    $ export HVR_CONFIG=/home/hvruser/hvr/hvr_config
    $ export HVR_TMP=/home/hvruser/hvr/hvr_tmp

    The commands to set the environment variables depend on the shell you use to interface with the operating system. This procedure lists examples that can be used in Bourne Shell (sh) and KornShell (ksh).

  2. Add the HVR executable directory path to the environment variable PATH.

    $ PATH=$PATH:$HVR_HOME/bin
  3. Add the HVR executable directory path into the startup file (e.g. .profile).

    export PATH=$PATH:$HVR_HOME/bin
  4. Execute the following commands to create the HVR installation directories - hvr_homehvr_config, and hvr_tmp:

    $ mkdir -m 01777 $HVR_CONFIG $HVR_TMP
    $ umask 022
    $ mkdir $HVR_HOME

    01777 sets the directory's sticky bit. If HVR needs to be run as different OS user, this allows all HVR processes to create files and folder underneath. All OS users can create files or sub-directories, but they can only remove their own files. By default, the files created by HVR will have permission 0600 (same as chmod 600), which means it will be readable and writable only by the same OS user.

    umask 022 is used so that the files and directories created in the following commands are readable by everyone (other Unix users and groups), but only writable by the owner.

    hvr_home is regarded a read-only directory. The user files saved in this directory will be moved to a backup directory when executing HVR for the first time or after an HVR upgrade.

  5. Execute the following commands to uncompress the HVR distribution file (e.g, hvr-5.6.0-linux_glibc2.5-x64-64bit_ga.tar.gz) into the hvr_home directory:

    $ cd $HVR_HOME
    $ gzip -dc /tmp/hvr-5.6.0-linux_glibc2.5-x64-64bit_ga.tar.gz | tar xf -
  6. If this installation is done for using 'HVR as a hub' then copy the HVR license file (hvr.lic) into the hvr_home/lib folder. The license file is normally delivered by the HVR Technical Support.

    $ cp hvr.lic $HVR_HOME/lib
    HVR license file is only required on the server where HVR hub is installed.
  7. If this installation is done for using 'HVR as a remote agent' then an HVR listener port must be configured. For more information, see Configuring Remote Installation of HVR on Unix or Linux.

For information about configuring HVR after installation, see section Configuring HVR.

After the installation, HVR can be controlled using HVR's graphical user interface (HVR GUI).

For HVR on Linux, HVR GUI can be executed directly on the hub server. However, an 'X Window System' application must be installed to execute HVR GUI directly on Linux. To control HVR remotely from your PC, install HVR on the PC (with Windows or MacOS) and configure HVR Remote Listener on hub server.

For HVR on Unix, HVR GUI should be typically executed remotely from a PC to control HVR installed on hub server. To do this, install HVR on the PC (with Windows or MacOS) and configure HVR Remote Listener on hub server.

Installation Notes

Notes for Oracle

If HVR must perform log based capture from Oracle, then the Unix username that HVR uses must be able to read the redo files and archive files that Oracle generates. This can either be done by adding HVR user to the oinstall or dba group in /etc/group. The permission to read these files can also be given by creating special access control lists (ACLs). For more information, see Requirements for Oracle.

Notes for Ingres

To perform log-based capture from Ingres a trusted executable must be created so that HVR can read from the internal DBMS logging files. For more information, see section Creating Trusted Executable in Requirements for Ingres and Vector.

See Also

For information about configuring HVR after the installation, see section Configuring HVR with the following topics: