Configuring Helix Search services
Note
You must be a admin user to configure Helix Search.
Tip
Helix Search can also be configured using the config.properties file, see Configure services used by Helix Search.
Configure Helix Search from the web UI.
To configure Helix Search from the web UI:
-
Open Settings from the side-navigation bar.
-
Select Configure.
The Helix Search configuration page is displayed.
-
Edit the Helix Search configuration:
-
To update the configuration with your changes, select Apply.
Configurable | Configurable name in config.properties file | Default | Description |
---|---|---|---|
Product Name | com.perforce.p4search.product | p4search | The name that is shown in the Helix server log. |
Product version | com.perforce.p4search.version | 0.1 | The product version that is shown in the Helix server log. Default value, the installed version of Helix Search. |
Log Configuration File | com.perforce.p4search.log | log4j2.xml | Set the log file name the Helix Search log is saved as. |
Host Address | com.perforce.p4search.host | 0.0.0.0 | The host IP address for the Helix Search service. |
Helix Search service Port | com.perforce.p4search.port | 1601 | The port number for the Helix Search service. |
Protocol | com.perforce.p4search.protocol | http | The protocol used for the Helix Search service. Options are: http or https. |
Java Keystore Location | com.perforce.p4search.secure.keystore | empty | Only if protocol is set to https. The location of the Java Keystore, see SSL security for Helix Search. |
Java Keystore Password | com.perforce.p4search.secure.keypass | empty | Only if protocol is set to https. The location of the Java Keystore, see SSL security for Helix Search. |
Configuration Security | com.perforce.p4search.security.required | true | Set to true to require log in with Helix server credentials to edit this configuration in the web UI. |
(CORS) Allowed Origin | com.perforce.p4search.access-control-allow-origin | empty | Cross Origin Resource Sharing (CORS). Specify an origin for the browser to allow resource access. |
Setup Retry Interval | com.perforce.p4search.setup.retry | 30000 | The retry interval used by Helix Search when locating ElasticSearch and Helix server Services (milliseconds). |
Perforce Port | com.perforce.p4search.p4port | localhost:4000 | The Helix server RPC host and port. For example, perforce.com:1666 or ssl.perforce.com:1666 if protocol is set to https. |
P4TRUST | com.perforce.p4search.p4trust | empty | The p4trust trusted fingerprint. |
Perforce Service User | com.perforce.p4search.service.p4user | super | The Helix server user account to authorize the proxy connection at security level 5 and higher. |
Perforce Service Ticket | com.perforce.p4search.service.p4ticket | AEEB1208CB06479B022D97C2784EEFDA | The long lived ticket to authorize the Perforce Service User. To print out a long lived ticket for the Perforce service user that is valid for all hosts, run the following command : p4 -p <p4port> -u <p4user> login -a -p |
Index Auth Token | com.perforce.p4search.config.token | 00000000-0000-0000-0000-000000000000 | An X-Auth-Token to validate configuration requests |
Indexer thread pool size | com.perforce.p4search.index.pool | 32 | |
Anonymous search user | com.perforce.p4search.anonymous.p4user | anonymous | An anonymous user can be provided for the unsupported search web pages. The anonymous user needs read permission in the Helix server for the areas of the depot you want to allow search result access to. Leaving the anonymous user and ticket values empty disables anonymous access: |
Anonymous search ticket | com.perforce.p4search.anonymous.p4ticket | empty | The long lived ticket to authorize the anonymous search user. |
Restricted changes | com.perforce.p4search.restricted | true | Set to true to index restricted Helix server changelists |
Max content file size | com.perforce.p4search.maxfilesize | 104857600 | The max file size (in bytes) that Helix Search will try and index it's content to. |
Parsing timeout (ms) | com.perforce.p4search.timeout | 20000 | Timeout when parsing a file through Tika (in milliseconds). |
Elasticsearch batch size | com.perforce.p4search.bulksize | 1000 | Maximum ElasticSearch batch size when indexing data. |
Trusted Services | com.perforce.p4search.trusted.ips | empty | A comma-separated list of trusted IP addresses for Proxy services. For example, the IP address for your Swarm instance. |
Permission Filter Required | com.perforce.p4search.permission.required | true | To filter user search results based on their Helix server permissions (output of the p4 protect command), set to true. This requires the installation of the Helix server p4search-filter plugin for Elasticsearch, see the Elasticsearch plugin documentation. Use of the Helix server p4search-filter plugin will introduce a small overhead in the query time. This is mainly determined by the number of protection entries that are applied to the user running the query. In some situations you might want to disable the filter if Helix Search only contains indexed data that is visible to all users. |
Perforce revision tags | com.perforce.p4search.index.tags | tags,thumb | A comma separated list of Helix server file revision attribute tags to index. |
Elastic search hosts | com.perforce.p4search.elastic.hosts | http://localhost:9200 | A comma separated list of host addresses for ElasticSearch. For example, http://localhost:9200,http://localhost:9201 |
Perforce index | com.perforce.p4search.index | perforce1 | Name for the ElasticSearch Helix server index. If you are using multiple instances of Helix Search ensure that you use a different index name for each instance. |
Elasticsearch track total hits | com.perforce.p4search.elastic.tracktotalhits | 10000 | Maximum accurately counted total hit by ElasticSearch. To tune performance, set a limit to the number of results processed by a single query. |
Elasticsearch username | com.perforce.p4search.elastic.user | empty | Elastic Search User for P4Search |
Elasticsearch password | com.perforce.p4search.elastic.pass | empty | Elastic Search Password for P4Search |
Help URL | com.perforce.p4search.helpurl | https://www.perforce.com/manuals/p4search/Content/P4Search/Home-p4search.html | The URL of the Helix Search help documentation. Enables you to change the URL of the help document. For example, if you are running an isolated system and need to host it on your own server. |