SearchBlox

SearchBlox Developer Hub

Welcome to the SearchBlox developer hub. Here you will find comprehensive guides and documentation to help you start working with SearchBlox as quickly as possible, as well as support if you get stuck. Let's jump right in!

Documentation

Remote Elasticsearch Cluster

When SearchBlox is connected with a remote Elasticsearch instance, indexed data can be stored remotely, ensuring a greater level of security.

You must use Elasticsearch Version 5.1.2 to connect a remote instance with SearchBlox.

Connecting a Remote Elasticsearch Instance

Elasticsearch Settings

Go to /<elasticsearch installation path>/config/elastisearch.yml and add the following lines at the bottom:
network.host: <IP address of the server>
cluster.name: test
script.inline: on
script.ingest: on

You should be able to access Elasticsearch using the URL http://<ipaddress>:9200.

Start the Elasticsearch instance in the server.
Elasticsearch must be started before starting the SearchBlox application.

Start SearchBlox and update the license.
After installing SearchBlox, start the application in the client machine and update the server license to the build.

Note that the remote cluster feature will work only with a server license.

Configure SearchBlox Settings

  1. Stop SearchBlox and go to /<searchblox installation path>/webapps/searchblox/WEB-INF/elasticsearch.yml and provide the details on the remote server and the cluster name as shown below.
  2. Disable all the other lines by prefixing "#" before the lines.

  3. Enter the IP address of the remote Elasticsearch instance
    searchblox.remote.es: <remote ip>
  4. Enter the cluster name of the remote Elasticsearch instance. By default it is
    searchblox
    searchblox.remote.es.cluster.name: test
  5. In the first line, provide the remote IP address, and in the second line provide the cluster name as it is listed in the remote Elasticsearch instance.

Restart SearchBlox
After making the necessary changes listed in the above steps, start SearchBlox. While starting SearchBlox the "connected to remote server" message will appear in the SearchBlox console.

Another way to check whether the indexes have been created in the remote index is to check Elasticsearch remotely by using an elasticsearch interface tool. You can also view in your browser here: http://<remote ip>:9200/_cat/indices.

Indexing and Searching
After indexing the collections, the data will be stored and retrieved remotely when a search is performed. Note that on the dashboard the collections display and appearance of search results will be slower using the remote Elasticsearch cluster, and the speed also depends on network connectivity.


License Required

A SearchBlox license key is required for accessing this feature.

Remote Elasticsearch Cluster