SMB Streaming Connector Installation Guide

Bundles Distribution

The SMB Streaming Connector uses agent-fleet-state for the distribution of bundles, using the same process as the agent.

Deployment flow:

1. Once a new bundle is deployed, the requested SMB artefacts are copied into a MinIO bucket on the customer's cluster.

2. Subsequently, the pod named static-server (an Nginx server) is restarted. Upon startup, this pod copies the artifacts from the MinIO bucket to /var/static/smb/(stable|beta).

3. From this point, the artifacts can be accessed via the following URLs:

   • https://{cluster}/static-server/static/smb/stable/ - for default stable deployment

   • https://{cluster}/static-server/static/smb/beta/ - for optional beta deployment

Open

The SMB Connector supports two types of artefact distributions:

1. Stable: This is the default distribution method for artefacts.

2. Beta: This method is for optional beta distribution.

SMB Download Page

The dashboard dynamically generates a download page for the available versions of artefacts—either stable or beta—based on the deployed bundles.

Open

If no bundle has been deployed, the following warning message will be displayed:

Open

SMB Connector Installation

This section addresses the different methods to install the SMB Connector on a single machine.

SMB Connector Pre-requisites:

• OS: Windows Server 2016 or later.

• Processor: 2 GHz or faster, 2 cores (64-bit processor recommended).

• Memory: 4GB RAM.

• Hard Disk: 1GB free space.

• Administrator Privileges: user needs admin permissions to install.

• .NET 8 must be installed.

Installation config

The SMB Connector supports various configuration options which can be specified via smb_connector_application_config.json

Manual Installation

Pre-requisites:

1. The ZIP of the installer files.

2. smb_connector_application_config.json file.

3. Windows Server machine access.

4. Admin access to install the connector.

Steps

1. Download the SMB Connector ZIP File: Obtain the ZIP file and save it to the Windows machine.

2. Prepare for Installation:

   • Unzip the contents of the ZIP file

   • Place the smb_connector_application_config.json file in the same directory as the unzipped contents.

3. Configure the Installer:

   • Edit the smb_connector_application_config.json file as needed. Use the smb_connector_application_config.json.example file in the unzipped folder if creating the configuration from scratch.

     Open

     

   • Create a folder mapping for every SMB share on the server that is to be scanned. WatchFolder should be the root directory of the share, and WebhookUrl should be from the scan configuration page for the SMB share on the GV dashboard (shown below).

     Open

     

   • Keep useDefaultFileFilters set to false if you want all files in the share to be scanned. If set to true, the connector will only scan files supported by the GV Synergy agent for classification.

   • IncludedExtensions and AdditionalFileFilters can be used if you wish to apply filters other than the defaults. IncludedExtensions supports file extensions in the format .txt, etc. AdditionalFileFilters allows for any custom file filter, including * as a wildcard

4. Start the Installation:

   • Execute the install.ps1 script by right clicking and choosing Run with Powershell

5. Complete the Installation:

   • After the installation completes, the powershell window can be closed.

Information for AV Scans

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

Please be sure that the SMB Streaming Connector is excluded from the below:

• Real Time Scans

• Scheduled Scans

• Manual Scans

Paths and executables to be excluded:

• C:\Program Files (x86)\SMBConnector\

• C:\Program Files (x86)\SMBConnector\SMBConnector.Windows.exe

Add the below list to the Trusted Applications

• C:\Program Files (x86)\SMBConnector\

• C:\Program Files (x86)\SMBConnector\SMBConnector.Windows.exe