SearchBlox

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!

Guides

Google Site Connector

Configuring SearchBlox

Before using Google Site Connector, install SearchBlox successfully, then create a Custom Collection.

Configuring API for Google Site

Steps to create client_secret.json and configure Google Site

  1. Go to https://console.developers.google.com/.
  2. Log in with the account username and password.
  3. Select a project if it already exists, or create a new project.
  1. To create a new project, you will be asked to fill in the project name and agree to terms of service.
  2. Next, click on the Products and Services list (menu) near Google APIs logo on left side.
  3. Choose API Manager and then click on credentials on the left side menu.
  4. In the resulting right pane, click on Create Credentials and select 'OAuth client ID' from the list.
  1. Configure the consent screen then choose the application type.
  1. Click on 'Configure consent screen' above the application type options.
  2. In the landing OAuth consent screen, the email ID field is chosen by default. Fill in the product name field and click on Save. Other fields in this page are optional.
    11.Now choose “Other Application”
  1. Download Json and rename it to client_secret.json
  2. Place it in the folder where the exe file is available

Configuring Google Site Connector

Prerequisites:

  • All the files related to the connector should be available in the same folder that is, all files should be extracted into the same folder.
  • Create a data folder on your drive where the files would be temporarily stored and mention in yml files.
    Contact [email protected] to request the download link for SearchBlox Google Site connector. In Windows, the connector would be installed in the C drive.

Steps to Configure and Run the Google Site Connector

  • Download the SearchBlox Google Site connector. Extract the downloaded zip to a folder.
  • Unzip the archive under *C:*
  • Configure the googlesites.yml file which includes Google Site properties and SearchBlox properties as listed here:

url

SearchBlox URL

api-key

SearchBlox API Key

data-directory

Data Folder where the data needs to be stored. Make sure it has write permission.

colname

The name of the custom collection in SearchBlox.

exclude-formats

File formats to exclude.

exclude-google-mime

Google mime types to be excluded

fetch-interval

Fetch interval between each hits (in seconds)

exclude-size

size of file that can be excluded in index

domain

website domain

siteName

site name specified in google sites

  • The content details of googlesites.yml are provided here:
#SearchBlox URL
url: http://localhost:8080/searchblox/rest/v2/api/
#SearchBlox API Key
api-key: C6D418861BAD66A46A7CC96B70CEADF9
#Data Folder where the data needs to be stored Make sure it has write permission
data-directory: C:\CONNECTORS\googlesite\data
#The name of the collection
colname: site
#The Excluded formats wont be indexed
exclude-formats: [.war,.zip,.tar.gz]
#The Excluded Google mime types wont be indexed
exclude-google-mime: [application/vnd.google-apps.video,application/vnd.google-apps.map,application/vnd.google-apps.unknown]
#Fetch interval between each hits (in seconds)
fetch-inverval: 1
#Exclude size above in MB
exclude-size: 2
#website domain
domain: searchblox.com
#site name
siteName: []
  • Start running the googlesites.exe file for Windows
  • First time you would get a URL in the console, copy that URL and post it in browser
  • Allow SearchBlox to access your account

Copy the string generated and paste it in console

  • Once giving enter the files would get indexed
  • Please note that this is a one time process, running the connector next time the crawler will start automatically.

Updated about a month ago


Google Site Connector


Suggested Edits are limited on API Reference Pages

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