Welcome to Voyager Help

Use the Search field below or select a Category from the list at the left

Configuration Options Using the Voyager.vmoptions File

Additional configuration options are available through the Voyager.vmoptions file, which can be found in <VoyagerInstallDir>\app.  Any changes to Voyager.vmoptions will be applied the next time Voyager is launched, or after restarting the Voyager service.

For the technically minded, this file controls Voyager's (Java) virtual machine (VM) and (Jetty) Servlet Container options. See (*) below for an explanation of Voyager.vmoptions, VoyagerServer.vmoptions and VoyagerService.vmoptions.

By default the file contains these settings:


# The Maximum Memory
-Xmx1024M
-XX:MaxPermSize=256M

# Ports
-Dport=8888

# The discovery will use 5 ports, starting with the configured port.  
-Dport.discovery=8900
# In this case:  8900,8901,8902,8903,8904

# Directories
-Ddata.dir=../data
-Dtemp.dir=c:/temp

 

The following settings can be modified or added to the file:

-Dapps.dir Path to the "apps" directory
-Dconfig.dir Path to the "config" directory
-Ddata.dir Path to the "data" 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 which contains thumbnails and cached metadata
-Dport

 

Port the Voyager web service runs on (as HTTP). Use -1 to disable HTTP if you have implemented HTTPS/SSL see Configuring Voyager to run under HTTPS/SSL.

-Dport.discovery Port the discovery process runs on
-Dtasks.dir Path to the "tasks" directory
-Dtemp.dir Path to the "temp" directory
-Dmeta.url URL to a remotely hosted meta directory
-Xmx256m Maximum Java heap size
-Dmd5.timeout Timeout for creating an MD5 hash (in milliseconds)
-Xms32m Initial Java heap size
-Dmax.ondemand.runners        Dynamic Thumbnail Generation. -1 = disabled, default value is 8

To run Voyager on non-standard URLs or run within IIS, the following settings can be configured:

\-Dcontext.path Required when not running from the root context
\-Dexplore.path Path to the default explore page
\-Dport.ajp Use AJP to run within IIS (requires ENTERPRISE license)

These settings should only be changed by experienced users. Typically this file will not need to be modified manually.

When setting any of the *.dir options, the path is case-sensitive and the target directory name must be included in the path. For example, the following is a valid value for the \-Dmeta.dir option: \-Dmeta.dir=c:\mydata\voyager\meta

(*) A Voyager installation contains three .vmoptions files by default:

  • Voyager.vmoptions - The parent configuration file described above
  • VoyagerServer.vmoptions - A vmoptions file applied specifically to VoyagerServer.exe at runtime. By default this file simply includes the contents of the parent Voyager.vmoptions, but can be used to override those configurations with Server-specific values. 
  • VoyagerService.vmoptions - A vmoptions file applied specifically to VoyagerService.exe at runtime. By default this file simply includes the contents of the parent Voyager.vmoptions, but can be used to override those configurations with Service-specific values.

Few users have the need for Server/Service-specific configurations.

Web Design and Web Development by Buildable