Runtime configuration
When Helix Search is installed and ready to use, the Helix Search configuration can be changed before use if required.
The location of the configuration file is specified by setting JVM property com.perforce.search.config, the environment, or a file called config.properties in the current local execution directory.
The order of precedence for determining the location of the configuration file is:
- JVM property com.perforce.search.configure located in sbin/p4search.vmoptions
- The Environment, see Set the configuration file location with the Environment.
- A local file called config.properties, see Set a local configuration file from a web page.
Set the configuration file location with the Environment
Linux:
Run the following command:
export com.perforce.search.config=<location>
Where <location> is the location of the configuration file. For example: /etc/p4search/config.properties
Windows:
Run the following Helix Core server command:
p4 set -s com.perforce.search.config=<location>
Where <location> is the location of the configuration file. For example: C:\Program Files\Perforce\P4Search\config.properties
The p4 set command is a convenient way to set the registry key HKEY_LOCAL_MACHINE
Set a local configuration file from a web page
If no configuration is provided the Helix Search service switches into configuration mode and can be configured through a web page. This creates a config.properties file in the current execution directory.
Navigate to the Helix Search configuration page using the connection details you set for the Helix Search service during the installation. For example:
http://localhost:1601/settings/settings/configure
By default, the web page requires you to log in with your Helix server credentials. To disable this change the following property to false:
com.perforce.p4search.security.required=false
When you have saved the configuration file, restart the service to exit configuration mode.
Useful topics
- For details of the Helix Search, Helix server, and Elasticsearch configuration, see Configure services used by Helix Search.
- Helix Search API endpoints
- Helix Search: Data model
- Legacy search endpoints (Apache Solr)