Content Comparison

...

The agent supports various initial agent configs which can be specified via installerConfig.json or CLI arguments: Synergy Agent: installerConfig.json and CLI config - GV-KnowledgeBase - Confluence (atlassian.net)

Manual Installation

Pre-requisites:

...

Download the Agent MSI File: Obtain the MSI file and save it to the Windows machine.
Prepare for Installation:
- Ensure all Office applications are closed to guarantee a clean installation of the agent.
- Place the installerConfig.json file (if provided by GV) in the same directory as the MSI file.
Configure the Installer:
- Edit the installerConfig.json file as needed, based on the provided documentation.Synergy Agent: installerConfig.json and CLI config
  /wiki/spaces/GS/pages/226820159
Start the Installation:
- Double-click the MSI file to launch the setup.
- Accept the terms in the License Agreement by checking the box, then click "Install".
- Click "Yes" when prompted to allow the app to make changes to your device.
Visual Studio Tools Check:
- During installation, if Microsoft Visual Studio Tools 2010 is not detected, a dialog box will appear.
- Check the box and click "Install" to add the necessary tools.
Complete the Installation:
- After the installation completes, press "Finish".

...

After closing the setup, you can monitor the deployment status and details from the SCCM console under the Deployments section.

Note:

Paths to Exclude for AV scans: to avoid slowness during installation are as below:

Please be sure that the Getvisibility application is excluded from the below:

Real Time Scans
Scheduled Scans
Manual Scans

Paths and executables to be excluded:

C:\Program Files (x86)\GVClient\
C:\Program Files (x86)\GVClient\\PlatformHub\GVClient.PlatformHub.Windows.exe
C:\Program Files (x86)\GVClient\\AgentEngine\GVClient.AgentEngine.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.AutoUpdateService.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.Classifier.Windows.exe
C:\Program Files (x86)\GVClient\\AgentUI\GVClient.AgentUI.exe
C:\Program Files (x86)\GVClient\\PlatformHub\Proxy\grpcwebproxy.exe

Add the below list to the Trusted Applications

C:\Program Files (x86)\GVClient\
C:\Program Files (x86)\GVClient\\PlatformHub\GVClient.PlatformHub.Windows.exe
C:\Program Files (x86)\GVClient\\AgentEngine\GVClient.AgentEngine.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.AutoUpdateService.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.Classifier.Windows.exe
C:\Program Files (x86)\GVClient\\AgentUI\GVClient.AgentUI.exe
C:\Program Files (x86)\GVClient\\PlatformHub\Proxy\grpcwebproxy.exe

Further installation steps

Further configuration steps after installation:

Preventing Users From Disabling Getvisibility Agent

References:

MSI file installation through GPO: https://community.spiceworks.com/how_to/160869-how-to-install-exe-with-group-policy
MSI file installation through SCCM: https://pdf.wondershare.com/business/how-to-deploy-software-with-sccm.html

Auto-Update

The auto-update feature of the agent allows to distribute new versions of the agent without reinstalling it on a user machine.

The agent utilizes the published .zip bundles for the auto-update process.

Prerequisites

Before auto-update can be initiated, the installation must meet the following prerequisites:

Not a Release Candidate (RC) Version: The installation cannot be an RC version. The current version type can be verified as follows:
- Windows: Check under the registry key Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Getvisibility\Global\IsRCVersion.
Server Access: The agent must have access to the server.
Availability of Auto-update Artifacts: This is detailed in the 'Distribution' section.
Auto-update Enabled: This is explained in the 'Configuration' section.

Note
The file names must remain consistent with those provided by the development team when published to the artifactory. Any deviation in the naming could result in a malfunctioning installation.

Configuration

By default, the auto-update functionality is disabled and can be enabled in dashboard.

...

The following properties can be adjusted:

Auto-update: Server URL or path - specifies the endpoint from where the agent will attempt to download updates. By default, it should be left empty, and agent will assume default values.

By default, the endpoint defaults to:
- https://{cluster}/static-server/static/agent/stable/ - for stable releases
- https://{cluster}/static-server/static/agent/beta/ - for beta releases
Custom URLs or paths don’t support beta releases.
It supports local file path - if this is the case, the full path to the directory must be provided, e.g. C:/Artifacts

If a custom URL is used it must be a NGINX File Server which lists the files in JSON format - configuration autoindex_format json. Example:

Code Block

server {
  listen 80;
  server_name auto-updater;
  access_log /var/log/access.log;
  error_log /var/log/error.log;

  location /static/ {
    alias /var/static/;
    autoindex on;
	autoindex_format json;
    gzip_static on;
    expires max;
    add_header Cache-Control public;
  }
}

Auto-update: regex for agent packages to include - specifies the regex which will be used for artifacts discovery. By default, it should be left empty, and agent will assume default values.
Auto-upate: check for updates frequency rate - how often the agent should look for updates. By default, it should be left empty, and agent will assume default values.
Enable beta version update - If this option is enabled and appropriate machine name entries are created, the targeted machines will attempt to fetch auto-updates from beta endpoints (https://{cluster}/static-server/static/agent/beta/) instead of stable endpoints (stable endpoint will be completely ignored by the agent).

...

The agent only supports upgrading via auto-update. It’s not possible to downgrade using auto-update functionality.

...

Further installation steps

Further configuration steps after installation:

Preventing Users From Disabling Getvisibility Agent

References:

MSI file installation through GPO: https://community.spiceworks.com/how_to/160869-how-to-install-exe-with-group-policy
MSI file installation through SCCM: https://pdf.wondershare.com/business/how-to-deploy-software-with-sccm.html

Auto-Update

The auto-update feature of the agent allows to distribute new versions of the agent without reinstalling it on a user machine.

The agent utilizes the published .zip bundles for the auto-update process.

Prerequisites

Before auto-update can be initiated, the installation must meet the following prerequisites:

Not a Release Candidate (RC) Version: The installation cannot be an RC version. The current version type can be verified as follows:
- Windows: Check under the registry key Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Getvisibility\Global\IsRCVersion.
Server Access: The agent must have access to the server.
Availability of Auto-update Artifacts: This is detailed in the 'Distribution' section.
Auto-update Enabled: This is explained in the 'Configuration' section.

Note
The file names must remain consistent with those provided by the development team when published to the artifactory. Any deviation in the naming could result in a malfunctioning installation.

Configuration

By default, the auto-update functionality is disabled and can be enabled in dashboard.

...

The following properties can be adjusted:

Auto-update: Server URL or path - specifies the endpoint from where the agent will attempt to download updates. By default, it should be left empty, and agent will assume default values.

By default, the endpoint defaults to:
- https://{cluster}/static-server/static/agent/stable/ - for stable releases
- https://{cluster}/static-server/static/agent/beta/ - for beta releases
Custom URLs or paths don’t support beta releases.
It supports local file path - if this is the case, the full path to the directory must be provided, e.g. C:/Artifacts

If a custom URL is used it must be a NGINX File Server which lists the files in JSON format - configuration autoindex_format json. Example:

Code Block

server {
  listen 80;
  server_name auto-updater;
  access_log /var/log/access.log;
  error_log /var/log/error.log;

  location /static/ {
    alias /var/static/;
    autoindex on;
	autoindex_format json;
    gzip_static on;
    expires max;
    add_header Cache-Control public;
  }
}

Auto-update: regex for agent packages to include - specifies the regex which will be used for artifacts discovery. By default, it should be left empty, and agent will assume default values.
Auto-upate: check for updates frequency rate - how often the agent should look for updates. By default, it should be left empty, and agent will assume default values.
Enable beta version update - If this option is enabled and appropriate machine name entries are created, the targeted machines will attempt to fetch auto-updates from beta endpoints (https://{cluster}/static-server/static/agent/beta/) instead of stable endpoints (stable endpoint will be completely ignored by the agent).

Note

The agent only supports upgrading via auto-update. It’s not possible to downgrade using auto-update functionality.

This means removing machine from beta endpoints will not result in the agent downgrading to the previous stable version.

Information for AV Scans

Paths to Exclude for AV scans to avoid slowness during installation are as below:

Please be sure that the Getvisibility application is excluded from the below:

Real Time Scans
Scheduled Scans
Manual Scans

Paths and executables to be excluded:

C:\Program Files (x86)\GVClient\
C:\Program Files (x86)\GVClient\\PlatformHub\GVClient.PlatformHub.Windows.exe
C:\Program Files (x86)\GVClient\\AgentEngine\GVClient.AgentEngine.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.AutoUpdateService.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.Classifier.Windows.exe
C:\Program Files (x86)\GVClient\\AgentUI\GVClient.AgentUI.exe
C:\Program Files (x86)\GVClient\\PlatformHub\Proxy\grpcwebproxy.exe

Add the below list to the Trusted Applications

C:\Program Files (x86)\GVClient\
C:\Program Files (x86)\GVClient\\PlatformHub\GVClient.PlatformHub.Windows.exe
C:\Program Files (x86)\GVClient\\AgentEngine\GVClient.AgentEngine.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.AutoUpdateService.Windows.exe
C:\Program Files (x86)\GVClient\\GVClient.Classifier.Windows.exe
C:\Program Files (x86)\GVClient\\AgentUI\GVClient.AgentUI.exe
C:\Program Files (x86)\GVClient\\PlatformHub\Proxy\grpcwebproxy.exe

EOD

Version	Old Version 6	New Version Current
Changes made by	Ashima Agarwal	Ashima Agarwal
Saved on	Sept 05, 2024	Sept 05, 2024

Versions Compared

Key

Manual Installation

Further installation steps

Auto-Update

Prerequisites

Configuration

Further installation steps

Auto-Update

Prerequisites

Configuration

Information for AV Scans