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!

Guides

Installing on Windows

Installation of SearchBlox 9.0

Prerequisites

  • Install Java JDK 11
  • After installation please make sure that environment variable for Java is set. Otherwise, set it manually by providing Java bin path in path variable in Environment settings as below:
    Note: If there are other java versions installed in the system, please remove the references from the path variable.

To check please give java -version in command prompt. You should get the response as below

Steps to install SearchBlox

  • Download the build for Windows.
  • Run the installer, then follow the wizard to install the application on your C: drive.

Steps to Run SearchBlox

  • First Start Elasticsearch by running C:\SearchBloxServer\elasticsearch\bin\elasticsearch.bat manually.
    Kindly note that this is mandatory for SearchBlox to run.
  • Check whether you are able to access elasticsearch using link
    https://localhost:9200
    default credentials
    username: admin
    password: admin
  • Once you start elasticsearch successfully, start running SearchBlox by running the executable C:/SearchBloxServer/StartSearchBlox.exe

It might take a few minutes for SearchBlox to start

  • Go to http://localhost:8080/searchblox/admin/main.jsp in your browser, accept the license agreement.
    • Give the username as admin
    • You will receive a custom password the first time you log in, after you accept the license agreement. Use the custom password to log in, then store or change the password for future logins.

JDK version 11 is required for running SearchBlox and for service installation.

Download JDK 11 from Oracle Java.

Installing Elasticsearch Service

  • Set JAVA_HOME as mentioned earlier in the prerequisites
  • Open command prompt go to C:\SearchBloxServer\elasticsearch\bin and run the following command
    elasticsearch-service.bat install

Installing SearchBlox as Service

  • Go to the C:\SearchBloxServer\services\bat\ folder within the SearchBlox installation.
  • Right-click the installService.bat file and run as Administrator. This will install the service.
  • You can start the service from the Control Panel > Administrative Services > Services panel in Windows. You can also start the service by running C:\SearchBloxServer\services\bat\startservices.bat

Please make sure that Elasticsearch (service or bat file) is running before starting searchblox service i.e., https://<IP>:9200 is accessible.

SearchBlox Installation in other Drive or Location

You can also install SearchBlox as a service from a different drive or location 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 (eg: D: drive or E: drive).
  • Set the SearchBlox Environment variable using the steps below (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 new path
        6. And add “D:\SearchBloxServer\services\bat”
    
  • Run installService.bat from D:\SearchBlox Server\services\bat to install.
  • Run the service.
  • Check the logs in the SearchBlox server to verify that SearchBlox has started successfully the first time.
  • To remove the service, run uninstallService.bat.

Uninstall SearchBlox

To uninstall SearchBlox,

  1. stop the service
  2. Go to the C:\SearchBlox Server\services\bat\ folder within the SearchBlox installation and uninstall the service by running uninstallService.bat
  3. Run **C:\SearchBlox Server\uninstall.exe" to uninstall the application
  4. Make sure to delete all the files within C:\SearchBloxServer for clean uninstall

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.