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!


Installing on Windows

Installation of Application

  • Download the build for Windows.
  • Run the installer, then follow the wizard to install the application on your C: drive.
  • Right-click C:\SearchBloxServer\startSearchBlox and select Run as Administrator to start the application. Choose Yes on the user account pop-up to start SearchBlox successfully.
  • 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 (for versions 8.6.1 and later). Use the custom password to log in, then store or change the password for future logins.

JDK version 8 is required for service installation.

Download JDK 8 from Oracle Java.

Installing SearchBlox as Service

  • Go to the C:\SearchBlox Server\services\bat\ folder within the SearchBlox installation.
  • Right click the installService.bat file and run as Administrator.
  • Alternatively, you can start the service from the Control Panel > Administrative Services > Services panel in Windows.
  • Once you see the message "The service has started", wait for few seconds then go to http://localhost:8080/searchblox/admin/main.jsp and accept the license agreement.
  • Log in to the admin console using the credentials below:

Username: admin
Password: admin.

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.

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.