This document describes the steps necessary on how to install and run Voyager HQ as a Windows Service.

Required Information for Setup

1. A Windows user account to run the Voyager HQ process/service.

   • The account must have sufficient permission to the data to be indexed. Permissions must allow open/read access to the files indexed.

   • The account must have read/write permissions to Voyager's install and data areas.

2. A Windows administrator account and password to install and configure Voyager HQ, including:

   • Configuring Active Directory settings (optional)

   • Installing or modifying the Windows service

3. Locations to be indexed, e.g.:

   • File server locations

   • SDE server

   • ArcGIS Web Servers

Additional Considerations

• The preferred method is to manage Voyager HQ as a Windows Service rather than a process running from a user account. This method ensures that the process will be available based on the configuration of the service. This also allows you to set permissions to those directories for the service account rather than setting permissions for user accounts. You will need to request that your IT department to create a Windows Service Account with a non-expiring password to use this method, and the necessary permissions will need to be granted to this account.

• When running Voyager HQ as a service, user has to be logged as a member of the local Administrators group to be able to check out an ESRI license.

• It is sometimes not possible to have a single account that has access to all of the data. For this scenario, Voyager HQ, when running as a service, has a "map network drive" feature that allows you to specify user credentials. This makes it easy to index data on other file shares with, or without, other credentials. This option can be located on the System page, it will only be visible if Voyager HQ is running as a Windows Service.

• Collect this information for each physical location where Voyager HQ is installed or will index data.

Related Topics

See these articles for more detailed information regarding Voyagers system and software requirements, supported formats, and indexing suggestions.

• Voyager Software and System Requirements

• System Sizing: Understanding and Tuning Voyager's Index, Meta Size, and Disk Use

• Machine Sizing Summary

Installation Guide

 During the installation of Voyager HQ, you will need to complete the following steps before accessing and using your instance. Alternatively, you can download the complete guide:

Instructions

Step 1: To begin installing Voyager HQ, go to the following download page on Voyager Search’s website that has all of the available software products: https://dl.voyagersearch.com/ 

Step 2: In the download page, choose from the download options for HQ under the Vose section. 

Open

Step 3: Open the Voyager HQ install file once it’s downloaded. Go to the file in your File Explorer, left click and then select Run as administrator.

Open

Step 4: The install4J Wizard pop-up will appear where Voyager HQ will begin installing on your device.

Open

Step 5: You may receive a Windows security warning asking whether you want to allow Voyager HQ to make necessary changes to your device since it’s from an unknown publisher. This message is safe to ignore. To proceed with the installation, select Yes. 

Open

Step 6: Select Next to begin going through the installation configuration steps.

Open

Step 7: Read the terms of the License Agreement and check the I accept the agreement option to indicate agreement. Select Next to proceed.

Open

Step 8: Choose to install into a directory by selecting a destination file on your device where Voyager HQ files will be stored. If no selection is made, it will default to the current Voyager HQ install directory. When a directory is selected then select Next.

Open

Step 9: Choose whether you want to install the Python Plugin that gives you access to our most recent Python libraries and packages. This is optional but does allow for creating custom pipeline steps and connectors in HQ using Python that can expand your data ingest workflows and increase flexibility. Check the Plugins box to download the Python Plugin during the installation. 

Open

Step 10: Uncheck the box for Create a Start Menu folder. Select Next to begin the installation. 

Open

Step 11: Check the Run Voyager HQ as a Service and then Use a special user account for running the service options. Include your Windows admin account username and password to provide credentials for installing Voyager HQ as a service. 

Open

Step 12: Voyager HQ will begin installing on your computer to the selected directory. This process can take several minutes. 

Open

Step 13: Once the installation is finished, uncheck the box next to Run Voyager HQ. This will prevent Voyager HQ from starting up as an application. Click Finish to close the wizard.

Open

Step 14: Go to your Windows Finder application and type in the search bar Services to locate the built-in application for managing the software that’s running on your computer. Click the Services application to open it. 

Open

Step 15: Once the Services app is open you will scroll close to the bottom of the window and find Voyager HQ. Left click over Voyager HQ and select Start. You will now see that it is Running under the status page where Voyager HQ will begin running on your machine as a service.

Open

Step 16: Navigate to your web browser and type http://localhost:8000 into the URL bar. It will open up Voyager’s HQ interface for setting up and configuring your instance. 

Open

Next Steps

After installing Voyager HQ as a Windows service, then proceed to the next section to setup and activate your instance: Voyager HQ License and Initial Setup

Learn more

Learn how Voyager HQ manages the configuration of Repositories, Pipelines and HTTP Client

1. Adding Repositories is described in this article

2. Managing Pipelines is described in this article

3. Configuring HTTP Client is described in this article