Installing Voyager Server as a Windows Service
This document describes the steps necessary on how to install and run Voyager Server as a Windows Service.
Required Information for Setup
A Windows user account to run the Voyager Server 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 Server, 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 Server 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 Server 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 Server, 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 Server is running as a Windows Service.
Collect this information for each physical location where Voyager Server is installed or will index data.
Related Topics
See these articles for more detailed information regarding Voyager system and software requirements, supported formats, and indexing suggestions.
Installation Guide
During the installation of Voyager Server, 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 Server, 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 Server under the Vose section.
NOTE: It is recommended to download the most recent version of Voyager Server
Step 3: Open the Voyager Server 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 Server will begin installing on your device.
Step 5: You may receive a Windows security warning asking whether you want to allow Voyager Server 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 Server files will be stored. We recommend including the server version number in the folder name for clarity. For example, when installing version 2.13, name the folder “Server_2.13”. If no selection is made, it will default to the current Voyager install directory. Select Next when a destination is selected.
Step 9: Uncheck the box for Create a Start Menu folder. Select Next to begin the installation.
NOTE: Since Voyager Server is being installed as a service then it wont be necessary to select a Start Menu Folder that would apply to applications.
Step 10: Check the Install Voyager as a Service and then the Use a special user account for running the service options. Include your Windows admin account username and password to provide credentials for installing Voyager as a service.
Step 11: Voyager Server will begin installing on your computer to the selected directory. This process can take several minutes.
Step 12: Once the installation is finished, uncheck the box next to Run Voyager Search. This will prevent Voyager from running as both a service and an application simultaneously. Click Finish to close the wizard.
Step 13: 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 app to open it.
Step 14: Once the Services app is open you will scroll close to the bottom of the window and find VoyagerService. Notice that the status is blank because it is not running yet. Left click over VoyagerService and select Start. You will now see that it is Running under the status page where Voyager will begin running on your machine as a service.
Next Steps
After installing Voyager Server as a Windows service, then proceed to the next section to setup and activate your instance: Voyager Server License and Initial Setup