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

Required Information for Setup

A Windows user account to run the Voyager Agent 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.
A Windows administrator account and password to install and configure Voyager Agent, including:
- Configuring Active Directory settings (optional)
- Installing or modifying the Windows service
Locations to be indexed, e.g.:
- File server locations
- SDE server
- ArcGIS Web Servers

Additional Considerations

The preferred method is to manage the Voyager Agent 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 Agent 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.
Collect this information for each physical location where Voyager Agent is installed or will index data.

Installation Guide

During the installation of Voyager Agent, 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 Agent, 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 Agent under the Vose section.

NOTE: It is recommended to download the most recent version of Voyager Agent.

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

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

Step 5: You may receive a Windows security warning asking whether you want to allow Voyager Agent 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.

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

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

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

NOTE: It is recommended that the destination file directory have the version number that’s being installed to keep tracking of versioning of your Voyager products. For example, “Agent_1.13” would be the name of the directory.

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.

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

NOTE: Since Voyager Agent is being installed as a service then it wont be necessary to select a Start Menu Folder that would apply to installing Voyager Agent as an application.

Step 11: Check the Run Voyager Agent 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 Agent as a service.

NOTE: Ensure that you are running Agent as a Windows Service under an admin user.

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

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

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.

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

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

Next Steps

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

Learn More

Configuring Agent with agent.vmoptions

See this article for more information about configuring Agent using the agent.vmoptions file.

Voyager Search Help System

Installing Voyager Agent as a Windows Service