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

Admin Dashboard

The admin dashboard helps you to configure collections, customize search settings, view the analytics related to collections, and view and configure admin settings. Only the users with admin credentials can access the admin dashboard.

Starting SearchBlox

After successful deployment to your server, SearchBlox starts up automatically. You can verify if SearchBlox has started successfully by viewing the status.log file in the /searchblox/logs folder. If you use a server console, it will display the following message, which will be logged in the status.log file.

INFO  <24 Apr 2018 18:07:58,151> <status> <SearchBlox Version 8.6.8>
INFO  <24 Apr 2018 18:07:58,151> <status> <JVM Vendor: Oracle Corporation>
INFO  <24 Apr 2018 18:07:58,151> <status> <JVM Version: 1.8.0_152>
INFO  <24 Apr 2018 18:07:58,151> <status> <Server Information : jetty/9.3.6.v20151106 Version 3.1>
INFO  <24 Apr 2018 18:07:58,151> <status> <OS Information : amd64|Windows Server 2012 R2|6.3>
INFO  <24 Apr 2018 18:07:58,151> <status> <Host IP Address : 45.56.125.173>
INFO  <24 Apr 2018 18:07:58,167> <status> <Memory: 3 GB | 3 GB>
INFO  <24 Apr 2018 18:08:15,339> <status> <2018/04/24 18:08:15 Scheduler started>
INFO  <24 Apr 2018 18:08:15,792> <status> <SearchBlox Started....>

Accessing the Admin Console

The Administration console for SearchBlox lets you do everything through a web-based browser. You can access the console with this link: http://localhost:8080/searchblox/admin/main.jsp. When you access SearchBlox for the very first time, it will display the License Agreement. Click on "I Agree" after reading through the License Agreement to get to the login page for the admin console. Through version 8.6, SearchBlox is pre-configured with the following username and password. Please log in using the following credentials:
Username: admin
Password: admin

From 8.6.1 onwards, you will receive a custom password the very first time you log in after you accept the SearchBlox license declaration. The password will be available below the login button as shown below. Use that password to log in, then store the password or change the password once you log in.

After you log in, you will be directed to the Admin Dashboard tab of the console.

The Admin Dashboard menu has the following sections:
Collections
Search
Analytics
Admin

Admin users and Manager users have access to all sections in the menu.

Business users may only access the Search and Analytics sections.

Securing Admin Dashboard using SAML

Steps in configuring SAML authentication in SearchBlox

  • Place the keystore file and identity provider meta file in <SearchBlox_installation_dir>/WEB-INF/class/saml folder
  • Go to <SearchBlox_installation_dir>/WEB-INF/saml-config.yml and provide relevant values for the fields as given below:

enablesamlauth: true
## keystore files should be placed before starting the SearchBlox Server
## Production - <SearchBlox deployed dir>/WEB-INF/classes/<place the files under custom folder or here (eg:-saml/)>
keystorepath: saml/samlKeystore.jks
keystorepassword: pac4j-demo-passwd
privatekeypassword: pac4j-demo-passwd
## Production - <SearchBlox deployed dir>/WEB-INF/classes/<place the files under custom folder or here (eg:-saml/)>
identityprovidermetadatapath: saml/testshib-providers.xml
searchbloxcontext: http://localhost:8080/searchblox
## SP Metadata Info ##
#sp-metadata.xml file created while first request of SAML authentication initiated
#sp-metadata.xml path tomcat server: <tomcat installation dir>/bin/
#sp-metadata.xml path jetty server: <jetty_home>

Please find the description of fields and the values to be provided in saml-config.yml file below table

enablesamlauth

Give the value as true to enable SAML authentication

keystorepath

Give the keystore file path.
Eg: If the files are placed in ../searchblox/WEB-INF/classes/saml then the keystore path value should be
keystorepath: saml/Keystore.jks

keystorepassword

Password used when generating keystore

privatekeypassword

Private password used when generating keystore

identityprovidermetadatapath

Path where the identity provider meta file is placed
Eg: If the files are placed in ../searchblox/WEB-INF/classes/saml then the keystore path value should be
identityprovidermetadatapath: saml/testshib-providers.xml

searchbloxcontext

SearchBlox location

  • After placing the relevant files in ../WEB-INF/classes/saml and giving the relevant details in the saml-config.yml, restart SearchBlox.
  • After Restart access SearchBlox admin dashboard i.e.,
    http://localhost:8080/searchblox/admin/main.jsp
  • If the service provider has been registered then the user should be able to log in using SAML authentication. Otherwise sp-metadata.xml file would be created with first request of SAML authentication in <jetty_home> in jetty server and <tomcat installation dir>/bin/ in tomcat server. Please use the same to register with the service provider to enable the authentication.