SearchBlox

SearchBlox Developer Documentation

Welcome to the SearchBlox developer documentation. Here you will find comprehensive technical 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!

Guides

Requirements

Resource

Requirement

CPU Cores

4 cores minimum
8 or 16 cores required for greater than 5 collections or 25,000 documents

Memory

16GB minimum
64GB for large number of collections/documents

Java Version

JDK 11

Java Memory Settings - SearchBlox

XMS and XMX values are set to 8 GB by default.
16GB for larger document volume or number of collections. Maximum 31 GB can be allocated.

Java Memory Settings - Elasticsearch

XMS and XMX values are set to 4 GB by default. Maximum 31 GB can be allocated.

Operating System / VM / Cloud

Windows 10, 2012, 2016, 2019
Linux - CentOS, RHEL, Ubuntu, Amazon Linux 2
VMWare / Hyper-V Supported
AWS, Azure, Google Cloud Supported

Disk Space

Disk space should be at least 2-3X the size of the data that needs to be indexed. If 1 GB of data needs to be indexed then the minimum disk space should be at least 2GB.
SSD is recommended.

Recommended Requirements

Recommended CPU/RAM requirements based on Documents/URLs indexed.

Documents/URLs

SearchBlox Requires

RAM on Server

Processing Power

0 - 100,000

8GB

16GB

4 or 8 cores

100,000 - 500,000

16GB

32GB

8 cores

500,000 - 1 million

31GB

64GB

16 cores

1 million +

Cluster Setup

Cluster Setup

Cluster Setup

📘

Tuning System Requirements

  • CPU and RAM requirements are a recommendation.
  • Requirements may vary based on volume of documents, number of collections, refresh frequency, and number of search users.

How to update the memory for SearchBlox and Elasticsearch?

By default 8 GB RAM is allocated to SearchBlox and 4 GB to Elasticsearch. Therefore minimum 16 GB RAM is required to run SearchBlox.

Update the memory allocation in Windows by editing the <SEARCHBLOX_INSTALLATION_PATH>/start.ini file within the SearchBloxServer folder.

-Xmx8g
-Xms8g

Change to 16g when you have at least a 32GB server:

-Xmx16g
-Xms16g

Update the memory allocation of elasticsearch by editing <SEARCHBLOX_INSTALLATION_PATH>\elasticsearch\config\jvm.options and updating xms and xmx value in line numbers 22 and 23 as shown below

-Xmx8g
-Xms8g

Please restart SearchBlox and Elasticsearch services after saving the changes.

Browser Compatibility

Browser

Version

Compatibility

Google Chrome

Chrome 68 and above

Admin Dashboard and Search works well in Chrome browsers
Below version 68 few features might not work

Mozilla Firefox

Firefox 40 and above

Admin Dashboard and Search works well
Below version 40 few features might not work

Internet Explorer

IE 8- IE11

Admin Console features not supported
Search Pages are supported in IE 8 and above

Safari

Safari 7 and above

Admin Dashboard and Search works well
Below version 7 few features might not work

Opera

Opera 44 and above

Admin Dashboard and Search works well
Below version 44 few features might not work

Updated 16 days ago



Requirements


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.