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!


Installing on Linux

Installation as Application


Install OpenJDK 8 on Linux prior to installing SearchBlox, and ensure it uses the default Java runtime. You can install OpenJDK 8 by running the following command:
su -c "yum install java-1.8.0-openjdk"
yum install wget

Steps for Installation

  • Please login as root using sudo su if you are not the root user.
  • SearchBlox can be installed by running the following command in path /opt :
    curl -s | sh
  • Check if the /etc/hosts file has an entry for the assigned IP address and host name. Restart the server once that is set up.
  • vi /etc/hostname
  • Manually run /opt/searchblox/startSearchBlox first (and then CTRL-C to kill after it is up and running) before the “service searchblox start” command is run.
  • Go to http://localhost/searchblox/admin/main.jsp in your browser, accept the license agreement
  • Give the username as admin
  • You will see a temp password displayed the first time you go to the login page, after accepting the license agreement. Use the temp password to log in, then store or change the password for future login.
  • By default, there will be one HTTP collection with the root URL, which can be updated if required. You can index a collection by clicking the index button from the dashboard or the Index sub-tab.
  • Click on the DashBoard sub-tab under Collections to view the indexing status.
  • Searchblox will run with a free license, by default, which allows you to use one collection only. To add another collection, delete the existing one and create another.
  • Go to http://localhost/searchblox/search.jsp or http://localhost/searchblox/plugin/index.html to start searching.

Running SearchBlox as Service

Please login as root before running the service commands for SearchBlox using
sudo su

  • To start the service, use the following commands:
    sudo service searchblox start
  • To stop the service, use the following commands:
    sudo service searchblox stop
  • If you want to restart SearchBlox,
    Please make sure to stop Searchblox completely, i.e., you need to make sure that the java process has stopped and then start after few minutes. Do not use service restart option. Use the following to restart SearchBlox.
    service searchblox stop
    ps -ef|grep java
    (stop additional java process related to SearchBlox)
    service searchblox start


If you notice startup issues with SearchBlox on Ubuntu, you can fix the issue by stopping SearchBlox and deleting the following jar file:

Updated about a year ago

Installing on Linux

Suggested Edits are limited on API Reference Pages

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