XenForo Enhanced Search

XenForo Enhanced Search is an add-on that replaces the built-in XenForo search system and is built to take advantage of elasticsearch to provide a higher performing and more flexible search system for XenForo. It can be purchased from XenForo.com directly.

XenForo Enhanced Search requires XenForo 1.3.0 or newer and elasticsearch 0.16.0 or newer. The Enhanced Search add-on requires a separate purchase to become available to a XenForo license.

Installation

  1. First, log in to the Customer Area and download the latest version of XenForo Enhanced Search.
  2. It is important that the files on the server and what you're uploading are "merged". Otherwise you may break your XenForo installation.
    Use your FTP client to connect to your server and navigate to the directory where you installed XenForo. Unzip the file you downloaded in step 1 and upload the contents of the upload directory into the directory where you installed XenForo.
  3. Log in to your XenForo admin control panel, and select Install Add-on from the left. In Install from file on server, enter library/XenES/addon-XenES.xml and submit the form.

After the caches rebuild, XenForo Enhanced Search is now installed and you should configure it and rebuild the search index.

Upgrading

  1. First, log in to the Customer Area and download the latest version of XenForo Enhanced Search.
  2. It is important that the files on the server and what you're uploading are "merged". Otherwise you may break your XenForo installation.
    Use your FTP client to connect to your server and navigate to the directory where you installed XenForo. Unzip the file you downloaded in step 1 and upload the contents of the upload directory into the directory where you installed XenForo. You should ensure that files are overwritten.
  3. Log in to your XenForo admin control panel, and select List Add-ons from the left. Under the Controls drop-down for XenForo Enhanced Search, select Upgrade. In Upgrade from file on server, enter library/XenES/addon-XenES.xml and submit the form.

After the caches rebuild, the XenForo Enhanced Search upgrade is complete.

Enhanced Search Configuration

Configuration Options

Several new options are created in Options > Search Options to control the elasticsearch server details. The option Enable Elasticsearch must be selected before data will be stored in or retrieved from elasticsearch.

After enabling elasticsearch for the first time, the search index should be rebuilt immediately or errors may occur when performing searches.

Elasticsearch Setup

Under Tools > Elasticsearch Setup, you may make adjustments to the analyzer that elasticsearch will use to perform searches:

  • The standard analyzer simply separates words based on spaces and some punctuation. This is roughly equivalent to the functionality of the built-in XenForo search.
  • The stemming analyzer separates words based on spaces and some punctuation, but goes a step farther and reduces words to their root. This allows a search for "tests" to automatically match results for "test", "testing", "tested", and other similar words. As the algorithm to find the root of a word is language-dependent, this analyzer only works correctly with English content.

Rebuilding the Search Index

To rebuild the search index, go to Tools > Rebuild Caches and select Rebuild Search Index.

The search index only needs to be modified if your elasticsearch configuration changes or if there are specific improvements in an upgrade that you want to take advantage of. Improvements that require a search index rebuild will be noted.