Installing on Windows

Installation on Windows

1. Download SearchBlox 10.5.1 for Windows.
2. Right-click the searchblox_windows64 file and run as Administrator. Install4j will set up the SearchBlox wizard and start the process for SearchBlox installation.

SearchBlox Installation Wizard starts up.

Choose the SearchBlox installation directory.

Chooses the SearchBlox startup shortcut by default.

SearchBlox installation in progress.

SearchBlox installation is complete.

3. The installer will install SearchBlox along with Elasticsearch and Analytics server for this application.

Prerequisites

• After installation please set JAVA_HOME and environment path variable for Java.

🚧

Please 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 on 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

👍

NOTE

• If SearchBlox is installed on D drive then JAVA_HOME value will be D:\SearchBloxServer\jre

4. Select Path under System Variable and add %JAVA_HOME%\bin as a new path.

5. Verify if Java is installed correctly by running the command: java -version

Start SearchBlox Service

1. Go to the C:\SearchBloxServer\service folder within the SearchBlox installation.
2. Right-click the install-service file and run as Administrator. This will install the service.

3. You can start the SearchBlox service manually from the Control Panel > System and Security > Administrative Tools> Services.

4. To Start SearchBlox Service, Right-click the Searchblox Enterprise Search and Click start.

🚧

Note

• Restart the Windows Server if you are not able to start SearchBlox.
• Check if Elasticsearch service is running.
• SearchBlox service will start automatically upon server restart.

• After you start the service, wait for 30 seconds then open the link: https://localhost:8443/console/ in your browser to access the SearchBlox Admin Console.
• You will be taken to the License Agreement page. Click on “I AGREE” at the bottom of the page.

• You will be taken to Create a Super Admin Create Password Page.

Use the Super Admin password to log in and access the dashboard page.

Verify Installation

• You can verify if SearchBlox has started successfully by viewing the status.log file in the C:\SearchBloxServer\webapps\ROOT\logs folder.
• Please confirm the message "SearchBlox Started" is shown in the log.
• In case of any errors, this log will provide additional information for troubleshooting.

You can see the SearchBlox Account details by clicking the Avatar Icon.

📘

Note

• 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 8443 by default. For secure ports refer Secure Ports used by SearchBlox section on Requirements

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

• Stop SearchBlox service
• Update C:\SearchBloxServer\start.d\https.ini file and add the below line to set the required port number:
  jetty.ssl.port=443
• Save the https.ini file
• Start SearchBlox service

SearchBlox Installation on alternate drive or path

We recommend installing SearchBlox in the C:\ drive. Please follow the following steps if you wish to install SearchBlox on a different drive. For example, if you want to install in D:\ drive, follow the below steps:

1. Download SearchBlox for Windows.
2. Run the Installation Wizard and give the preferred installation path. By default, it will be C:\SearchBloxServer change it to D:\SearchBloxServer.

• For the next steps refer Installation on Windows section from step 3 and 4.
• Set the Java Environment variable for the location (example: D: drive or E: drive).
• To set the Java Environment variable follow the steps from Prerequisites section.

To update Elasticsearch/Analytics installation path:

• Go toD:\SearchBloxServer\webapps\ROOT\WEB-INF.
• In searchblox.yml file, in the lines 7, change the value of es.home to D:\SearchBloxServer\analytics, and in the line 16, change the value of searchblox-analytics.home to D:\SearchBloxServer\analytics.

# ======================== SearchBlox Configuration =========================
searchblox.deployment.type: onPrem
searchblox.elasticsearch.host: localhost
searchblox.elasticsearch.port: 9200
searchblox.elasticsearch.basic.username: xxxxxxxxxx
searchblox.elasticsearch.basic.password: xxxxxxxxxxx
es.home: D:\SearchBloxServer\elasticsearch

searchblox.refresh_interval: 4s
searchblox.shards: 1
searchblox.replicas: 0
searchblox.http.crawldepth: -1
searchblox.user.expiry: 30

searchblox.analytics.url: https://localhost:8444
searchblox.analytics.home: D:\SearchBloxServer\analytics



http.lastmodified.header: SearchBlox-Last-modified

• Now save the searchblox.yml file.
• To Start the SearchBlox service, go to D:\SearchBloxServer\service and follow the steps from the Start SearchBlox service section.

Uninstall SearchBlox

1. To Stop the SearchBlox service. Go to Control Panel > System and Security > Administrative Tools> Services.

2. Go to the C:\SearchBloxServer\service and uninstall SearchBlox service by running uninstall-service as administrator.

3. Run SearchBlox uninstall.exe file from Installation Directory.

SearchBlox Uninstallation successful.

4. Delete C:\SearchBloxServer folder for clean uninstall.

🚧

Note

After the uninstallation, it is required to restart the machine when prompted. This action will terminate all the existing background services if any.