Administrator Installation Notes

Owned by Cooper Labenske
Apr 04, 2022
2 min read

This is an administrative step-by-step guide to the typical Basic or Advanced Server environment installation. It includes how to set up Voyager for your web portal URL, how to set different configuration options such ports and directory locations, and how to run Voyager as a service.

1. Make sure you have the latest version of Voyager installed

Visit voyagersearch.com/downloads to check for the most recent release. Note the the availability of both x32 and x64 bit versions. 

2. Log In as Administrator

Before you can make changes to Voyager's configuration, log in as the Administrator user.

  • Default Administrator Username: admin

  • Default Administrator Password: admin

3. Verify Your License

To verify your license, go to Manage > Settings > License. If you need a different license or your evaluation / interim license is about to expire, please contact sales@voyagersearch.com.

3. Set the Voyager URL

To use your company website as your Voyager portal location, change the Voyager URL setting at Manage Voyager > Settings.

NOTE: By default, Voyager runs on port 8888. If you need Voyager to use a different port, make sure you include it in the URL, for example

htttp://yourwebsite.com:8888

5. Configure Voyager settings (optional)

To configure Voyager ports, folders locations, and other settings, edit the Voyager.vmoptions file, which can be found in: <VoyagerInstallDir>\app.

Use Voyager.vmoptions to configure the ports Voyager uses, the folder location of the index and thumbnails, URL settings, and any map caching folder.

You can add or modify the following settings:

-Dapps.dir

Path to the apps directory

-Dconfig.dir

Path to the config directory

-Ddata.dir

Path to the data directory

-Ddesktop.dir

Path to the desktop directory

-Dextract.dir

Path to the extract directory

-Dlogs.dir

Path to the log directory

-Dmap.cache.dir

Path to the map cache

-Dindex.dir

Path to the indexV4 directory which contains the indexed data

-Dmeta.dir

Path to the meta directory for thumbnails and cached metadata

-Dport

Port the Voyager web service runs on 

-Dport.discovery      

Port the discovery process runs on 

-Dtasks.dir

Path to the tasks directory

-Dtemp.dir

Path to the temp directory

-Xmx256m

Maximum Java heap size

-Xms32m

Initial Java heap size

To run Voyager on non-standard URLs or to run within IIS, you can change the following settings:

-Dcontext.path     

required when not running from the root context

-Dexplore.path

path to the default Explore page

6. Configure Indexing Locations

Configure the locations that Voyager indexes. When starting out, it is best to start small to ensure ensuring  everything is working well and to get a sense for performance. Once you gain experience, you can add more locations with more data. 

To index SDE data, point Voyager to an ArcCatalog generated .sde connection file

8. Tune Data Discovery Settings

Tuning data discovery settings can help improve indexing performance.  

9. Use Worker Configuration to Optimize Performance 

Use these settings to ensure that the computer reaches a maximum of 70-80% CPU utilization. Values higher than this may cause your system to lock up or freeze.

10. Configure the Base Map

If necessary, you can configure Voyager's base map to use any map service that you like. To set the base map, go to Manage Voyager > Settings > Mapping.

You can pick one of the default base maps or add a new map service from the options provided.