Install a Search Engine

This page explains how to install FusionAuth Search, which provides full-text search. This service may be horizontally scaled using Elasticsearch clustering.

FusionAuth currently supports Elasticsearch versions 7.6.1 through 7.17.x. Later versions may work, have been tested for compatibility.

OpenSearch version 2.x should also function properly with FusionAuth version 1.42.0 or higher.

The RAM required by Elasticsearch or OpenSearch depends on your login volume and user/entity counts. If you expect to have a few logins per minute and only a few thousand users/entities, 1GB-2GB of RAM will suffice. For more users/entities as well as logins, we recommend running load tests to help size your install.

Download the Package#

Navigate to the Downloads page and find FusionAuth Search package for your target platform.

Install the Package#

To install on a Red Hat system, use the RPM bundle. Execute this command to install the FusionAuth Search RPM (replace <version> with the correct version number):

sudo rpm -i fusionauth-search<version>.rpm

To install on a Debian system, use the DEB bundle. Execute this command to install the FusionAuth Search DEB (replace <version> with the correct version number):

sudo dpkg -i fusionauth-search<version>.deb

To install on macOS, use the .zip bundle. Extract the fusionauth-search zip bundle anywhere on the file system. Remember where you extract the file. This location will be referred to as FUSIONAUTH_HOME. We suggest extracting this file to a directory such as /usr/local/fusionauth.

Once the zip bundle has been extracted, the directory structure should look similar to this. If you installed somewhere other the default FUSIONAUTH_HOME, your directory structure will be different, this is only for shown as an example.

/usr/local/fusionauth/bin
/usr/local/fusionauth/config
/usr/local/fusionauth/config/fusionauth.properties
/usr/local/fusionauth/fusionauth-search

To install on Windows, use the .zip bundle. Extract the fusionauth-search zip bundle anywhere on the file system. Remember where you extract the file. This location will be referred to as FUSIONAUTH_HOME. We suggest extracting this file to a directory such as \fusionauth on Windows.

Once the zip bundle has been extracted, the directory structure should look similar to this:

\fusionauth\bin
\fusionauth\config
\fusionauth\config\fusionauth.properties
\fusionauth\fusionauth-search\

Next, install the Windows service by changing to the directory designated as FUSIONAUTH_HOME and runing the install command:

cd \fusionauth\fusionauth-search\elasticsearch\bin

\fusionauth\fusionauth-search\elasticsearch\bin> FusionAuthSearch.exe /install

Configuration#

If you will be running more than one search engine service, or the search engine is installed on a separate server than the FusionAuth App service, you will need to modify the default configuration in the fusionauth.properties file.

If you have installed the Search Engine service on the same server that is running FusionAuth App no further configuration is required.

Each server running the FusionAuth Search service will need to be added to the configuration. To do this, you will need to edit the fusionauth.properties configuration file. More information about this configuration file is located in the Configuration Reference section.

The following examples assume that FusionAuth App and FusionAuth Search can communicate either on localhost if running on the same system, or if running on separate systems that a site local connection exists between both servers. If you require communication between FusionAuth App and FusionAuth Search on a public IP address, you will also need to modify the fusionauth-search.hosts property on the server running FusionAuth Search. The default value will only bind to localhost and site local IP addresses. See the Configuration Reference for more information on configuring the fusionauth-search.hosts property.

The following examples also assume the default port as specified by the fusionauth-search.transport-port property. If this value has been modified, adjust the examples accordingly.

Example Configuration 1#

The following is an example where FusionAuth Search is running on the same server as FusionAuth. This is the default configuration, if this is how you have your system configured, no change to fusionauth.properties is required.

fusionauth.properties

fusionauth-search.servers=localhost:9020
fusionauth-app.search-engine-type=elasticsearch
fusionauth-app.search-servers=http://localhost:9021

Example Configuration 2#

The following is an example where the FusionAuth Search is running on a separate system than the FusionAuth App and the FusionAuth Search Engine has an IP Address of 192.168.1.41.

We’ll refer to the server running FusionAuth App as System 1, and the server running FusionAuth Search as System 2.

fusionauth.properties on System 1

fusionauth-search.servers=192.168.1.41:9020
fusionauth-app.search-engine-type=elasticsearch
fusionauth-app.search-servers=http://192.168.1.41:9021

fusionauth.properties on System 2

fusionauth-search.servers=localhost:9020
fusionauth-app.search-engine-type=elasticsearch
fusionauth-app.search-servers=http://localhost:9021

Example Configuration 3#

When configuring multiple Elasticsearch nodes, you will need to modify the service discovery settings in the shipped elasticsearch.yml. See Elasticsearch’s Discovery and cluster formation settings documentation in configuring multiple nodes.

The following is an example where FusionAuth Search is running on the same server as FusionAuth App, and another server also has both the FusionAuth App and the FusionAuth Search installed.

We will refer to these systems as System 1 and System 2, where System 1 has an IP address of 192.168.1.41 and System 2 has an IP address of 192.168.1.42.