HubStor Inc.

How to Install and Configure the Retrieval Service

The HubStor Retrieval Service can be downloaded from the HubStor Admin Portal, under 'Administration' and then 'Tools & Utilities'. 

Step 1 -- Run the Installer

NOTE: The account you are logged in as on the machine to which you are installing the Retrieval Service will need to be a local machine administrator.

Open the Retrieval Service installer file 'HubStor.RetrievalService.msi' with 'Run as administrator'. This will open the install wizard on the welcome step.

Click 'Next' to proceed.

Step 2 -- Acceptable Use Policy

You will need to read and accept the HubStor Acceptable Use Policy (AUP) before proceeding. Of special note, you have rights to use HubStor installable software in your organization as long as your subscription to HubStor is active. You can also find the AUP here: HUBSTOR ACCEPTABLE USE POLICY (AUP).

Click 'Next' to proceed.

Step 3 -- Service Account Credentials

Enter the credentials for the service account you have created for the HubStor Retrieval Service. This service account needs local machine administrator rights on the target file servers where it is installed.
Click the 'Validate' button to confirm the credentials pass and click OK. 

Click 'Next' to proceed.

Step 4 -- Install Path

Optionally change the install path.

Click 'Next' to proceed.

Step 5 -- Execute the Installation

Click 'Install' to execute the installation.

The install execution performs an automatic start of the Windows service.

When installation is complete, click 'Finish'.

Step 6 -- Launch the HubStor Export Service GUI

Go to the Start menu, find the HubStor Retrieval Service app, and open it.

Step 7 -- Configure the Retrieval Service

Establish the Connection

When launching the Retrieval Service app for the first time, it will default to the 'Settings' tab with 'General' and 'Advanced' settings sub-tabs.

In the 'General' tab, enter StorSite Web Service URL for the HubStor tenant along with the credentials of the service account that is configured in HubStor for the Retrieval Service. This account will need to be authorized in HubStor with the following rights:

  • API authorization
  • Access all items

By default, a Retrieval Service account is created when a new tenant is provisioned.  The account credentials can be obtained by contacting HubStor support.  Or, for instructions on how to configure authorization on an account that will be used by the Retrieval Service, see HOW TO CONFIGURE AUTHORIZATION FOR THE RETRIEVAL SERVICE'S HUBSTOR ACCOUNT

With the URL and credentials, entered, click the 'Interactive Login' button to authenticate for the connection between the Retrieval Service and your HubStor tenant.

Next, click the 'Apply' button at the bottom right of the app window. This will save your changes and establish your connection.

Caching (Optional)

Configure caching if you wish for retrieved items to be held locally for a period of time to optimize subsequent retrievals of the fetched items. This way, if an item is regularly retrieved from a seamless stub, the first time it will be downloaded from the cloud, but the next time - provided it is cached - it will be fetched from the local cache instead of incurring another cloud download.

There are two settings to configure caching:

  1. Cache Duration -- This is the number of days items will be kept in the Cache Location. Set it to '0' if you do not wish for any caching to occur.  
  2. Max. Cache Size (GB) -- This sets a storage capacity threshold on the local cache. HubStor uses a first in, first out (FIFO) queuing approach when the cache is at capacity, meaning it will remove the oldest files first.  
  3. Cache Location -- This is the path on the local server where cached items will be stored. It is recommended to change this location to a non-system drive when possible.  
The Retrieval Service will run daily checks to keep the cache location updated. It will first prune files based on the number of days set and then based on size to keep within the parameters configured.  

The 'Run Cleanup Now' button will only remove data that meets the same two criteria and not remove everything from cache.  

Process Exclusions (Optional)

Configure 'Process Exclusions' to avoid applications/processes from invoking unwanted retrievals from HubStor.

To add a process exclusion, click the 'Add Exclusion' button. This will display a window whereby you can identify the application/process to be excluded, either by executable or directory.

User Exclusions (Optional)

To support excluding network scan processes from causing unwanted retrieval of stubs, User Exclusions can be used. 

This will work nearly identically to the process exclusion, except by pattern matching against the user domain/id rather than a folder path. There are a few examples presented in the dialog when adding the exclusion.

Note: This should not be considered a security setting. The kernel mode driver may still serve the file depending on the internally cached state of the file within the kernel (if another user is currently using the file, for example). The retrieval service always relies on ACL configuration for security.

Advanced Settings

Under the 'Advanced' sub tab you will find the following settings:

  • # Threads -- This determines how many folders will be processed in parallel by the Retrieval Service when executing export jobs.
  • Log Directory -- This is the output path where you will find the event logs for the Retrieval Service.

Pre-ingest Encryption Settings

If you are using the pre-ingest encryption option in the HubStor Connector Service along with seamless or link-based stubbing, then you probably want the Retrieval Service to automatically decrypt any encrypted content it exports from HubStor so that users can access their content as expected.

If you are planning to use link-based stubs, you will need to enable the checkbox 'Act as Link-based Stub Retrieval Server' and configure the 'Stub Share' path. For more information on link-based stubbing, see OVERVIEW OF LINK-BASED STUBBING.

    • Related Articles

    • How to Install and Configure the HubStor Export Service

      The HubStor Export Service can be downloaded from the HubStor Admin Portal, under 'Administration' and then 'Tools & Utilities'.  Step 1 -- Run the Installer Open the Export Service installer file 'HubStor.ExportService.msi'. This will open the ...
    • Overview of Seamless Stubbing and the Retrieval Service

      The Retrieval Service is a Windows Server agent that must be deployed on all file servers front-ending the storage you plan to tier to the cloud with the 'seamless stubbing' option. With the Retrieval Service installed, connectors can be configured ...
    • How to Install and Configure the HubStor Connector Service (HCS)

      If you have access to the HubStor Admin Portal, you can download the HubStor Connector Service installer by going to 'Administration' and then 'Tools & Utilities'. Step 1 -- Run the Installer Open the HCS installer file ...
    • How To Move The Blob Cache Folder or Delete The Contents

      The procedure for moving a Retrieval Service Blob Cache folder typically involves manually deleting the contents of the Blob Cache folder.  This article will cover the steps to accomplish both procedures.  If you are only interested in removing ...
    • Overview of Background Exports and the Export Service

      The async/background export feature supports two use cases: Self-service user bulk downloads -- The Export Service can be ideal if you are storing large files in the cloud and wish to mitigate data proliferation by designating approved download ...