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

Confluence Data Source

Configuring SearchBlox

Before using Confluence Data Source, install SearchBlox successfully and create a Custom Collection.

Prerequisites

For Windows:

  1. Download zoneinfo.zip into any directory (preferably C drive).
    https://sbgoclient.s3.amazonaws.com/confluence/confluence_refresh/zoneinfo.zip
  2. Add a system variable named ZONEINFO, and the value should be the path of zone info zip.
    For example, System variable name ZONEINFO and value= C:\zoneinfo.zip
  3. Save the Environment variable.

Linux

  1. Download zoneinfo.zip into /usr.
    https://sbgoclient.s3.amazonaws.com/confluence/confluence_refresh/zoneinfo.zip
  2. Go to bash_profile file using the following command:
    vi ~/.bash_profile
  3. Add the following in the file and save:
    export ZONEINFO=/usr/zoneinfo.zip

📘

Note:

These steps are mandatory for the connectors to refresh the data. The preceding setup has to be done before running fresh connector.

Steps to Configure and Run the Confluence Fresh Run Data Source

  • Download the SearchBlox Connector UI. Extract the downloaded zip to a folder.

Contact [email protected] to request the download link for SearchBlox Connectors UI. The following steps include the example paths for both Windows as well as Linux. In Windows, the connector would be installed in the C drive.

  • Unzip the archive under C:* or /opt*.
  • Create a data folder on your drive where the files would be temporarily stored.
  • Configure the following properties once you create a data source in the connector UI.

Accessing Connector UI

🚧

Note:

In Linux, make sure that necessary permissions have been provided to the folder /opt by using the CHMOD command for writing log files and executing jar files.

  • Configure the confluence.yml file which includes confluence properties and SearchBlox properties as listed in the following:
usernameUser Name for Confluence account
passwordEncrypted Password for Confluence account
data-directoryData Folder where the data needs to be stored. Make sure it has write permission.
api-keySearchBlox API Key
colnameThe name of the custom collection in SearchBlox.
urlSearchBlox URL
confluenceurlConfluence URL
exclude-formatsFile formats to exclude. Please give the extension of the file with dot operator as in the example
Example: .war,.zip

Note: regex not allowed
exclude-foldersFolders to exclude in confluence. The subpath folder in the confluence URL to be excluded.
example: folder1, folder2

Note: regex not allowed, full folder name has to be provided
max-folder-sizeMaximum size of static folder after which it should be sweeped in MB.
log-file-maxSizeMegabytes after which new file is created.
og-file-maxBackupsNumber of backups after which log file should be deleted.
log-file-maxAgeNumber of days after which log files should be deleted.
Url, servlet url & delete-api-url:Make sure that the port number is right. If your SearchBlox runs in 8443 port the URLs should be right.

Updated 6 months ago


Confluence Data Source


Suggested Edits are limited on API Reference Pages

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