Configuring HQ with the hq.vmoptions file
- Cooper Labenske
- Brian Goldin
Owned by Cooper Labenske
Voyager HQ can be configured using the hq.vmoptions file in a manner similar to configuring Voyager Server using the Voyager.vmoptions file.Â
The hq.vmoptions file is located in the HQ installation directory, for example C:\Program Files\Voyager\HQ. An example is shown below.
hq.vmoptions
# ------------
# -= MEMORY =-
# ------------
# The maximum java heap size. On systems with more memory it's beneficial to increase this setting.
# A general guideline is to ensure that this value doesn't exceed half of the available system
# memory, up to a maximum of 6-8 gigabytes.
# Example: on a system with 8G of total ram a good setting is 4G: -Xmx4g
-Xmx728m
# -----------
# -= PORTS =-
# -----------
# The web / http port for the server.
# -Dport=8000
# The port used for communication between the foreman and worker processes.
# -Dforeman.chat.port=9010
# The port used by workers to send results to after file extraction.
# -Dforeman.results.port=9011
# The port used by HQ for communication with indexing agents.
# -Dagent.port=9000
# -----------------
# -= DIRECTORIES =-
# -----------------
# The home directory containing data and configuration. This folder
# can get very large as data is indexed. It's recommended that it
# set to a location that resides on a drive with lots of free space.
#
# On Windows systems the home directory defaults to the "AppData"
# directory, typically at "C:\Users\\AppData\Roaming\Voyager\hq".
# On Mac and Linux systems the home directory defaults to the user
# home directory, at "~/.voyager/hq".
# -Dhome.dir=
#
# The following directories all reside by default under "home.dir".
#
# The directory used to store server configuration files.
# -Dconfig.dir=
# The directory used to create short lived temporary files.
# -Dtemp.dir=
# The directory used to store longer term temporary files.
# -Dwork.dir=
# The directory for log files. Depending on log settings log files can get
# large.
# -Dlogs.dir=Note: by default the config, temp, work, logs and other folders will reside within the home folder.