Skip to content

Elasticsearch#

Elasticsearch is an alternative to the standard search function of WoltLab Suite, which is based on the fulltext index of MySQL. Elasticsearch based search offers better quality search results and, especially with larger data volumes, significantly higher performance.

Note

This article is intended for customers who run the software independently on their own server or web hosting. In case of hosting in the WoltLab Cloud, Elasticsearch is already installed and preconfigured.

System Requirements#

The following requirements must be met to use Elasticsearch:

  • PHP extension curl
  • Elasticsearch 5+
  • Plugin elasticsearch integration installed (paid plugin)

Configure Elasticsearch#

After the elasticsearch integration plugin has been installed, all configuration settings for Elasticsearch can be found in the admin panel under Configuration → Options → General → System → Search.

The following configuration settings are available:

Setting Description
Search Engine Select Elasticsearch to enable the use of Elasticsearch.
Elasticsearch Server Enter the address of the Elasticsearch server.
Elasticsearch Username Enter the credentials for authentication with the Elasticsearch server, if required by the server.
Elasticsearch Password Enter the credentials for authentication with the Elasticsearch server, if required by the server.
Elasticsearch Client Certificate (Public Key) For certificate-based authentication with the Elasticsearch server, enter the public key.
Elasticsearch Client Certificate (Private Key) For certificate-based authentication with the Elasticsearch server, enter the private key.
Elasticsearch Index Prefix Specify a prefix for the created indexes.
Allow leading wildcard Allows the use of the wildcard character at the beginning of search terms.
Relevance Score: Period Specify the period for relevance weighting.
Relevance Score: Function Select the function for relevance weighting.

After activating Elasticsearch the search index must be regenerated. To do this, go to the administration interface Management → Maintenance → Rebuild Data and perform all actions that update the search index.