Running the Network Share Scanner (Beta)

The new FileCloud Network Share Scanner, a more efficient indexer service than FileCloud Helper, monitors file system events on LAN-based Network Folders, enabling use of advanced FileCloud features with files in Network Folders including:

• User workflows

• Content Disarm and Reconstruction (CDR)

• Antivirus integration

• Metadata rules

• Data Loss Prevention (DLP)

• Content Classification Engine (CCE)

Once you are running the Network Share Scanner, these features will function successfully when you specify network share paths using the root external.

The Network Share Scanner is available on both Linux and Windows systems. It is currently in beta and requires manual setup. In a future release, the service will be configurable through the FileCloud control panel.

Start/Manage Network Share Scanner

Note that on Linux, you must install the Network Share Scanner, but it Windows it is already installed.

Windows

To start the Network Share Scanner in Windows:

1. Navigate to the folder:

   C:\xampp\eventsapi
   
   

2. Start the Event API and Network Share Scanner (NSS) services by entering:

   FC-EventApi.exe run
   FC-NSS_Maestro.exe start
   
   

   
   

   
   For more information about running the service, enter:
   

   FC-EventApi.exe run --help
   OR 
   FC-EventApi.exe --help
   

   
   or
   

   FC-NSS_Maestro.exe start --help
   OR
   FC-NSS_Maestro.exe --help
   

Linux

To install the Network Share Scanner in Linux:

filecloudcp -e → install EventAPI
filecloud -n → installs network share scanner

To manage the Network Share Scanner in Linux:

On Linux, the services start automatically after you install them.

Use a regular service manager to manage the services. For example, to stop the service,  enter:

systemctl stop fceventapisystemctl stop fcnetworksharescanner

Operation Modes

The Network Share Scanner supports two operation modes:

• Adaptive Mode
  (Default) Monitors file system events in real time and updates the index accordingly. If this mode fails, the service falls back to polling.

• Polling Mode
  Periodically scans the file system for changes and updates the index.

To change the operation mode:

1. In C:\xampp\eventsapi, open networker-config.yaml.

2. Scroll down to the line:

   watch_strategy: adaptive # adaptive or polling																																										
   

   The default setting is adaptive. 

3. You may change it to polling to scan periodically, and change it back to adaptive to scan in real time.

4. Restart FCC-NSS_Maestro.exe for the change to take effect.

Log management

The Network Share Scanner includes several settings for managing your log output.

To manage your logs:

1. In C:\xampp\eventsapi, open networker-config.yaml.
   You can change your log settings in the section that appears as:

   log:
       stdout: false
       level: info
       path: logs
       filename: log.json
   

   
   The settings options are shown in the following table:
   

2. Restart FCC-NSS_Maestro.exe for any changes to take effect.