Requirements

To ensure optimal performance and scalability for SearchBlox and the SearchAI ChatBot, it is essential to meet the recommended hardware and software requirements. These guidelines are designed to support efficient indexing, searching, and AI-driven interactions based on your document volume and workload demands.

Below, you’ll find detailed specifications for:

• Minimum and recommended CPU, memory, and disk configurations
• Java version and memory settings for both SearchBlox and Elasticsearch
• Supported operating systems and cloud environments
• Scalable resource allocations based on document volume and collection size
• Additionally, the SearchAI ChatBot has specific high-performance requirements to handle AI-powered search and conversational responses effectively.

For larger deployments (1 million+ documents), a cluster setup is recommended to maintain speed and reliability. Adjustments may be necessary depending on indexing frequency, query load, and concurrent user activity.
Let’s explore the detailed requirements to ensure your deployment runs smoothly.

Recommended Requirements

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

🚧

Tuning System Requirements

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

Memory Tuning for SearchBlox and Opensearch

To optimize the performance of SearchBlox and OpenSearch, you may need to adjust the memory allocation based on your server's available resources. Here’s how to do it:

Default Memory Allocation:

• SearchBlox: 8 GB RAM
• OpenSearch: 4 GB RAM
• Minimum Requirement: 16 GB RAM to run SearchBlox effectively.

Updating Memory Allocation for SearchBlox:

1. Locate the JVM Configuration File:
   Navigate to the <SEARCHBLOX_INSTALLATION_PATH>/start.d/jvm.ini file within the SearchBloxServer folder.
2. Edit the JVM Options:
   Update the -Xmx and -Xms values to allocate more memory if your server has sufficient resources. For example:
   -Xmx8g
-Xms8g
3. If you have at least 32 GB of RAM, you can increase the allocation to 16 GB:
   -Xmx16g
-Xms16g

Updating Memory Allocation for OpenSearch:

1. Locate the JVM Configuration File:
   Navigate to the <SEARCHBLOX_INSTALLATION_PATH>\opensearch\config\jvm.options file.
2. Edit the JVM Options:
   Update the -Xmx and -Xms values in lines 22 and 23. For example:<SEARCHBLOX_INSTALLATION_PATH>\opensearch\config\jvm.options and updating xms and xmx value in line numbers 22 and 23 as shown below
   -Xmx8g -Xms8g

Summary of Memory Allocation

Restart the SearchBlox Service. After making these changes, restart the SearchBlox service to apply the new memory settings.

Browser Compatibility

Secure Ports used by SearchBlox

SearchBlox uses specific ports for secure communication and internal operations. Below is a breakdown of the ports used:

Public Ports:

• SearchBlox:
  Port: 8443
  Protocol: HTTPS
  Purpose: Used for accessing the SearchBlox Admin Console and search services securely.
• ConnectorsUI:
  Port: 8446
  Protocol: HTTPS
  Purpose: Used for managing connectors and data source integrations securely.

Ports for Internal Server or Network Access:

• OpenSearch:
  Ports: 9200 & 9201
  Purpose: Used for communication with the OpenSearch search engine, which powers the search functionality.
• Cluster:
  Port: 9300
  Purpose: Used for internal communication between nodes in a SearchBlox cluster.
• Multicast:
  Port: 54327
  Purpose: Used for multicast communication within the cluster.
• Hazelcast:
  Port: 5701
  Purpose: Used for distributed data storage and cluster management.
• Zookeeper:
  Port Range: 2000-2100
  Purpose: Used for coordination and synchronization services within the cluster.

Summary of Ports used

Important Notes:

• Ensure that these ports are properly secured and only accessible to authorized systems and users.
• Configure firewalls to allow traffic on these ports for internal communication while restricting access to public ports as needed.
• Ensure that the network configuration supports the required communication between cluster nodes and services.
• Ensure your server has enough physical memory to accommodate the increased allocation.
• Monitor the system performance after making changes to ensure optimal operation.
• Always back up configuration files before making changes.

By understanding and configuring these ports correctly, you can ensure secure and efficient operation of your SearchBlox deployment.