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

Installing on Windows

Installation on Windows

  • Download SearchBlox for Windows.
  • Run the installer, then follow the wizard to install the application on your C: drive.
  • The installer will install SearchBlox, elasticsearch, and the analytics server for this application.
  • Version 9.2 of SearchBlox is supported on Windows 2012, 2016 and 2019.

Prerequisites

  • After installation please set JAVA_HOME and environment path variable for Java.
    Note: If there are other java versions installed in the system, please remove the references from the path variable.

To set the environment variable:

  1. Right-click My Computer, select Properties and click Advanced System Settings.
  2. On the Advanced tab, select Environment Variables
  3. Create a new system variable JAVA_HOME with value C:\SearchBloxServer\jre
  1. Select path variable and add %JAVA_HOME%\bin as a new path
  1. Verify if Java is installed correctly by running the command: java -version

Start Elasticsearch Service

  1. Open command prompt as Administrator, go to C:\SearchBloxServer\elasticsearch\bin and run the following command:
    elasticsearch-service.bat install

If you plan to use an alternate drive location such as D: drive for SearchBlox installation, please edit the D:\SearchBloxServer\elasticsearch\bin\elasticsearch-env.bat file to update the JAVA_HOME path to D:\SearchBloxServer\jre

  1. You can start the service from the Control Panel > Administrative Services > Services panel.
  1. Verify the elasticsearch service by opening the browser and going to the URL:
    https://localhost:9200/
    username: admin
    password: admin
  1. You can make the service automatic in the services panel so elasticsearch service starts automatically on restart.

Stop Elasticsearch Service

To stop Elasticsearch service, please run the following command in the folder C:\SearchBloxServer\elasticsearch\bin :
elasticsearch-service.bat stop

Start SearchBlox Service

  1. Go to the C:\SearchBloxServer\services\bat\ folder within the SearchBlox installation.
  2. Right-click the installService.bat file and run as Administrator. This will install the service.
  3. You can start the SearchBlox service manually from the Control Panel > Administrative Services > Services panel.
  • Restart the Windows Server if you are not able to start SearchBlox.
  • Check if Elasticsearch service is running, if not start the Elasticsearch service before starting SearchBlox.
  • SearchBlox service will start automatically upon server restart.

After you start the service, wait for 30 seconds then go to http://localhost:8080/searchblox/admin/main.jsp in your browser to access the SearchBlox Admin Console.

Stop SearchBlox Service

  1. Go to the C:\SearchBloxServer\services\bat\ folder within the SearchBlox installation.
  2. Right-click the stopService.bat file and run as Administrator.

Start Analytics Server

Start the Analytics server to display search query data on the Analytics page within SearchBlox Admin Console. The Analytics Server will use port 4000.

  1. Go to the folder C:\SearchBloxServer\analytics
  2. Run cubejs.bat as administrator

Stop Analytics Server

To stop the Analytics service, please terminate the process using Control-C or terminate the process using the Task Manager.

Verify Installation

  • You can verify if SearchBlox has started successfully by viewing the status.log file in the <SEARCHBLOX_INSTALLATION_PATH>/webapps/searchblox/logs folder. Please confirm the message "Started Successfully" is shown in the log. In case of any errors, this log will provide additional information for troubleshooting.

  • To learn about Troubleshooting visit: Logging and Troubleshooting

  • To learn about using SearchBlox Admin Console visit: Overview of SearchBlox

  • To learn about tuning for high performance visit: Installation Tuning

Change SearchBlox Server Port

SearchBlox Server runs on port 8080 by default.

You can change the port by following the steps as shown here:

  1. Stop SearchBlox service
  2. Update the port number in the C:\SearchBlox Server\start.ini file at line number 163 to set the required port number:
    jetty.http.port=8080
  3. Save the start.ini file
  4. Start SearchBlox service

SearchBlox Installation on alternate Drive or Path

You can install SearchBlox from a different drive or path using these steps:

  • Edit the file ..\SearchBlox Server\services\conf\wrapper.conf and change the value for searchblox_home=C:\\SearchBlox Server\\ to the deployed location. Use the double slash in the path.
  • Set the Java Environment variable for the location (example: D: drive or E: drive).
  • Set the SearchBlox Environment variable using the following steps(This may be required in few systems)
    1. Go to Control Panel -> System and Security
    2. Select Advanced System Settings
    3. Select Environmental Variable
    4. Under System, Variables Select PATH and click EDIT
    5. Click New to add a new path
    6. And add D:\SearchBloxServer\services\bat
  • Update elasticsearch installation path in <SEARCHBLOX_INSTALLATION_PATH>/webapps/searchblox/WEB-INF/searchblox.yml
searchblox.elasticsearch.url: https://localhost:9200/
searchblox.basic.username: admin
searchblox.basic.password: admin
es.home: D:\SearchBloxServer\elasticsearch
  • Please edit the D:\SearchBloxServer\elasticsearch\bin\elasticsearch-env.bat file to update the JAVA_HOME path to D:\SearchBloxServer\jre
  • Go to D:\SearchBloxServer\elasticsearch\bin folder and run the command
    elasticsearch-service.bat install
  • Run installService.bat from D:\SearchBlox Server\services\bat to install SearchBlox service.
  • Run the elasticsearch and SearchBlox services.
  • Wait for 30 seconds.
  • Check the status.log to verify if SearchBlox has started successfully.
  • To remove the SearchBlox service, please stop elasticsearch and SearchBlox and then run uninstallService.bat

Uninstall

To uninstall SearchBlox :

  1. Stop the elasticsearch service, SearchBlox service, and Analytics server
  2. Open the command prompt as Administrator,
  3. Go to C:\SearchBloxServer\elasticsearch\bin and uninstall elasticsearch service by running the command:
    elasticsearch-service.bat remove
  4. Go to the C:\SearchBlox Server\services\bat\ and uninstall SearchBlox service by running the command:
    uninstallService.bat
  5. Run C:\SearchBlox Server\uninstall.exe to uninstall the application.
  6. Delete all the files within C:\SearchBloxServer and remove the folder for clean uninstall.

Updated 2 months ago



Installing on Windows


Suggested Edits are limited on API Reference Pages

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