Setting up WordPress Search using SearchBlox


SearchBlox’s WordPress plugin is the easiest means of facilitating communication between a WordPress website and a SearchBlox Server. Once the plugin is installed and configured, SearchBlox is not only able to index an entire WordPress site, but also to include content from numerous collections – Twitter, Amazon S3, even third party sites – in search results. All without writing a line of code.

How to Integrate A WordPress Site With SearchBlox

Task 1 – Create an empty Collection on SearchBlox for your WordPress Site

Task 2 – Install and Sync WordPress plugin
Locate SearchBlox Credentials
Upload and Activate SearchBlox WordPress plugin
Configure plugin by adding SearchBlox credentials
Specify Collection
Sync Posts

Task 3 – Add SearchBlox to the WordPress Front End

How to Integrate External Collections with SearchBlox for WordPress

How to Add an Amazon S3 Bucket to SearchBlox for WordPress

How to Add A Website to SearchBlox for WordPress

How to Add a File System to SearchBlox for WordPress

How to Add a Twitter to SearchBlox for WordPress



Setup Instructions

Task 1 – Create an empty Collection on SearchBlox for your WordPress Site

The first step towards successfully integrating SearchBlox with a WordPress site takes place on your SearchBlox server. On the SearchBlox server, you will need to set up a blank collection. The SearchBlox for WordPress plugin will use the SearchBlox API to fill this collection.

You can log into your SearchBlox server via the web interface. Once logged in, adding a collection only takes three clicks.

Add Collection Button, SearchBlox AdminFirst, on the SearchBlox admin home screen, click the “Add Collection” button. The button is located near the top of the screen, just below navigation.

After you’ve started the process of adding a blank collection for WordPress, the first step is to name the collection. SearchBlox collection names are case sensitive and do not allow for either spaces or certain punctuation marks. However, the SearchBlox collection namespace is limited to each server install, which makes naming collections easier.

As the SearchBlox for WordPress plugin takes advantage of the SearchBlox API, you will need to select “Custom Collection” as the Collection Type.

How to add a blank WordPress Collection to SearchBlox

After you have named your Collection and selected “Custom Collection” as your collection type, you can specify the language or click the “Add” button. This will add an empty collection to your SearchBlox sever.

 
Back to top
 

Task 2 – Install and Sync WordPress plugin

Step 1 – Locate SearchBlox Credentials

Prior to installing the SearchBlox for WordPress plugin, you need four prices of information from your SearchBlox server:

  1. SearchBlox API Key
  2. Server Address
  3. Server Port
  4. Collection Name

Both the API Key and SearchBlox Server address can be found in the Admin section of your SearchBlox Server.

SearchBlox Admin Section - where to find your API Key

Item 3 (port number) will be dictated by your server setup. And Item 4 (Collection Name) is the name of the empty collection you created in Task 1 – Create an empty Collection on SearchBlox for your WordPress Site

 

Step 2 – Upload and Activate SearchBlox WordPress plugin

After you’ve noted the required information, the next step is to upload the SearchBlox for WordPress plugin to your WordPress website. You can find the latest version of the plugin from several places – via the “Add New Plugins” section of the dashboard, the WordPress Plugins Directory, or the SearchBlox download page.

When you have uploaded the SearchBlox for WordPress plugin to your WordPress website, go to the plugins Section of your WordPress website and activate the plugin.

Click Activate to Enable WordPress Plugin

 

Step 3 – Configure plugin by adding SearchBlox credentials

location of SearchBlox menu in WordPressOnce you’ve Activated the SearchBlox for WordPress plugin, you need to configure the plugin so it can talk to your SearchBlox server.

First, locate the SearchBlox menu in your WordPress Admin section’s left hand menu.

Clicking “SearchBlox” in the menu will start the configuration process. Enter your API Key, Server name, and Port Numbers. If SearchBlox and WordPress are on the same server, use the server’s external IP address.

How to configure SearchBlox for WordPress Plugin

After clicking the “Save Configuration” button, the SearchBlox for WordPress plugin will attempt to contact the SearchBlox server. If an error is encountered, the WordPress plugin will provide information on where the error was encountered. Else, the plugin will proceed to Step 4.

 

Step 4 – Specify Collection

How to specify SearchBlox Collection in WordPress

Enter the name of the Collection you created in Task 1. Upon clicking the “Save Configuration” button, the SearchBlox for WordPress plugin will contact your SearchBlox server and attempt to locate the Collection. If the specified Collection is not found, an error message will be displayed. Else, the plugin will proceed to Step 5.

Step 5 – Sync Posts

Sync WordPress with SearchBlox

After the SearchBlox for WordPress plugin has been successfully configured, you will need to manually synchronize your SearchBlox collection with the contents of your WordPress site.

Clicking the “Synchronize with SearchBlox” button will automatically take care of all of the synching setup and indexing.

how do you know when SearchBlox has indexed WordPress?

After you see this screen, you WordPress website is indexed and your WordPress Collection is now accessible through your SearchBlox server.
 
Back to top

 

Task 3 – Add SearchBlox to WordPress Front End

Indexing and synchronizing your WordPress site into a SearchBlox collection enables your WordPress site to be searched from SearchBlox and any SearchBlox front end.

The next step is to add a SearchBlox front end to your WordPress site. This requires you to do at least two things.

Step 1 – Specify Which Collection You Wish to Include

SearchBlox allows you to include an unlimited number of Collections from over a dozen different Collection types in a unified search.

By default, SearchBlox for WordPress will include all Collections on your SearchBlox Server in search results.

To limit the Collections included in your SearchBlox for WordPress searches, click on the “Search Collections” link in the SearchBlox section of your WordPress Admin menu. This will bring up a menu of all available Collections that the SearchBlox for WordPress plugin can see.

Assign collections to include in SearchBlox searches

By default, the plugin serves results from all visible Collections. If any Collection is checked, the search results will be limited to just the Collections with check marks.

After selecting or deselecting collections, click the “Save Settings” button to proceed.

 

Step 2 – Create SearchBlox Page

Once you have determined which Collections to include in your SearchBlox search results, the next step is to create a page for your search to live on.

In your WordPress website, create a new page and include [searchblox_search] in the body.

How to add SearchBlox results page to WordPress

Once, published, this page will house a search field and display search results from your SearchBlox Server.

SearchBlox Search for WordPress Results Page

Unlike the default WordPress search, SearchBlox provides users with metadata about their searches. This information – including items like Content Type, Age, and Collection – allows users to put search results in context.

Like other WordPress plugins, you have control over where the SearchBlox page displays and how it appears.
 
Back to top
 

How to Integrate External Collections with SearchBlox for WordPress

SearchBlox Free Edition allows for indexing a single Collection. By purchasing the Server Edition, users can add a number of Collections limited only by server hardware. Once these Collections are created, they are easily accessible through WordPress, and results are served right next to WordPress content.

Collection types include:

  • Google Drive
  • Amazon S3
  • CSVs
  • Twitter
  • Websites (HTTP)
  • RSS Feeds
  • MongoDB
  • Other Databases
  • File Systems
  • Custom Applications (via the SearchBlox API)

 

How to Install a SearchBlox License

In order to upgrade from SearchBlox Free Edition to SearchBlox Server Edition, you need to purchase a license. This license can be applied directly to your SearchBlox Free Edition and does not require downloading a new application or a change to your API Key. You can start the process of purchasing a license here.

After you have downloaded a license, upload the license to your your SearchBlox Server. In the Admin section of the SearchBlox control panel, there is a field marked “New License.”

how to upload a SearchBlox Product Key

Click the “Browse…” button to locate the copy of your license. After you have found the license, click the “Upload” button. SearchBlox will verify the key and then unlock or update Server Edition.
 
Back to top
 

How to Add an Amazon S3 Bucket to SearchBlox for WordPress

To add an Amazon S3 Bucket to your Searchblox for WordPress, you will first need to set up the Amazon S3 Collection. If you do not already have an Amazon S3 account, you can sign up for a free account here. Integrating with Amazon S3 is a fantastic way to easily and economically increase the number and variety of documents you include in your SearchBlox collections.

Step 1 – Add New Collection

On the SearchBlox Server main page, click the “Add Collection” button. As with other Collections, the first step is to name your Collection and pick the Collection Type. As expected, the Collection type is “Amazon S3 Collection.”

how to create a SearchBlox collection for Amazon S3

Click the “Add” button to return to the SearchBlox Server main page.

 

Step 2 – Configure Collection

From the SearchBlox Server main page, click the name of your Amazon S3 Collection to go to the Configuration Screen. Here you will be asked to fill out several fields. You will need to provide the Access Key, Secret Key, and Bucket Name from your Amazon S3 account.

How to setup an Amazon S3 bucket in SearchBlox

After you have added this information, click the “Save Changes” button and return to the SearchBlox main page.

 

Step 3 – Index Your Amazon S3 Collection

After your Amazon S3 Bucket has been added to SearchBlox Server, you will want to manually start an index. You can do this right from the Main page by locating the Amazon S3 Collection in your Collections list and clicking the “Index” button.

Indexed Amazon S3 Bucket in SearchBlox

 

Step 4 – Add Amazon S3 Collection to SearchBlox for WordPress plugin

Once SearchBlox Server has indexed your Amazon S3 Bucket, the Collection should be immediately available to your SearchBlox for WordPress websites.

To verify that these Collections are being included in your WordPress search functions – log into your WordPress website and go to “Search Collections” under the SearchBlox section of the Admin Menu. There you will see a list of all Collections that the SearchBlox for WordPress plugin has access to.

If no Collections are checked, then the SearchBlox for WordPress plugin includes all collections in search functions. If one or more Collections are checked, then you will need to check the box next to the recently added Amazon S3 Collection.

Assign collections to include in SearchBlox searches

After making changes, click the “Save Setting” button.

After a few moments, this Collection will be included in WordPress search functions.
 
Back to top
 

How To Add A Website to Search Blox for WordPress

To add a Website to your Searchblox for WordPress, you will first need to set up the Website as a Collection.

Step 1 – Add New Collection

On the SearchBlox Server main page, click the “Add Collection” button. As with other Collections, the first step is to name your Collection and pick the Collection Type. As expected, the collection type is “HTTP Collection”

How to add a website as a SearchBlox Collection

Click the “Add” button to return to the SearchBlox Server main page.

 

Step 2 – Configure Collection

From the SearchBlox Server main page, click the Configure Collection button to go to the Configuration Screen. Here you will be asked to fill out several fields. You can specify root URLs you wish to crawl, paths you wish to allow (and disallow) and file formats you want to include or exclude from results.

How to configure a website collection in SearchBlox

After you have added this information, click the “Save Changes” button and return to the SearchBlox main page.

 

Step 3 – Index Your Website Collection

After your Website Collection has been added to SearchBlox Server, you will want to manually start an index. You can do this right from the main page by locating the Website Collection in your Collections list and clicking the “Index” button.

Indexing a website with SearchBlox

 

Step 4 – Add Website Collection to SearchBlox for WordPress plugin

Once SearchBlox Server has indexed your external website, the Collection should be immediately available to your SearchBlox for WordPress websites.

To verify that these collections are being included in your WordPress search functions – log into your WordPress website and go to “Search Collections” under the SearchBlox section of the admin menu. There you will see a list of all Collections that the SearchBlox for WordPress plugin has access to.

If no Collections are checked, then the SearchBlox for WordPress plugin includes all Collections in search functions. If one or more Collections are checked, then you will need to check the box next to the recently added website Collection.

Assign collections to include in SearchBlox searches

After making changes, click the “Save Settings” button.

After a few moments, this Collection will be included in WordPress search functions.
 
Back to top
 

How To Add A File System to Search Blox for WordPress

To add a File System to your Searchblox for WordPress, you will first need to set up the Filesystem as a Collection.

Step 1 – Add New Collection

On the SearchBlox Server main page, click the “Add Collection” button. As with other Collections, the first step is to name your Collection and pick the Collection Type. As expected, the Collection type is “Filesystem”

fs-add-collection

Click the “Add” button to return to the SearchBlox Server main page.

 

Step 2 – Configure Collection

From the SearchBlox Server main page, click the Configure Collection button to go to the Configuration Screen. Here you will be asked to fill out several fields. You can specify paths you wish to crawl, paths you wish to allow (and disallow) and file formats that you want to include or exclude from results.

How to configure a File System collection in SearchBlox

After you have added this information, click the “Save Changes” button and return to the SearchBlox main page.

 

Step 3 – Index Your Filesystem Collection

After your Filesystem Collection has been added to SearchBlox Server, you will want to manually start an index. You can do this right from the Main page by locating the Filesystem Collection in your Collections list and clicking the “Index” button.

fs-index

 

Step 4 – Add Filesystem Collection to SearchBlox for WordPress plugin

Once SearchBlox Server has indexed your file system, the Collection should be immediately available to your SearchBlox for WordPress websites.

To verify that these Collections are being included in your WordPress search functions – log into your WordPress website and go to “Search Collections” under the SearchBlox section of the admin menu. There you will see a list of all Collections that the SearchBlox for WordPress plugin has access to.

If no Collections are checked, then the SearchBlox for WordPress plugin includes all collections in search functions. If one or more Collections are checked, then you will need to check the box next to the recently added website Collection.

Assign collections to include in SearchBlox searches

After making changes, click the “Save Settings” button.

After a few moments, this Collection will be included in WordPress search functions.
 
Back to top
 

How To Add a Twitter to Search Blox for WordPress

To add Twitter search to your Searchblox for WordPress, you will first need to set up Twitter as a Collection.

Step 1 – Create a Twitter App

The first step in adding Twitter as a searchable Collection in SearchBlox requires the creation of a Twitter Application. Creating a Twitter Application requires first having a valid Twitter account. You can create a Twitter Account free here.

After you have created a free Twitter account, you will need to proceed to Apps.Twitter.com and start the process of creating a Twitter Application.

At Apps.Twitter.Com, click on the “Create New App” button.

The "Create New App" button

 

 

This will bring up a screen which asks you for three pieces of information, none of which will be publicly visible when using Twitter with SearchBlox:

  • Application Name – this name must be unique among all Twitter Applications.
  • Description – this is the description of your Application. This does not have to be unique.
  • Website – this is the website where the Application will be available. This should be the website where you are running SearchBlox, but technically can be any website you wish.

 

How to create a Twitter Application

After you have created your Application, proceed to the “Key And Access Tokens” tab. Here you’ll need to scroll down and click the “Create my access token” button. This will generate a second set of tokens.

How to find your Key and Access tokens on Twitter

When your Access token has generated, you have access to the four pieces of information required to configure your Twitter Collection on Searchblox:

  1. Consumer Key
  2. Consumer Secret
  3. Access Token
  4. Access Token Secret

Note these four pieces of information and proceed to your SearchBlox Server for Step 2.

 

Step 2 – Add Twitter Collection

On the SearchBlox Server main page, click the “Add Collection” button. As with other Collections, the first step is to name your Collection and pick the Collection Type. As expected, the collection type is “Twitter.”

How to add a Twitter Collection to SearchBlox

Click the “Add” button to return to the SearchBlox Server main page.

 

Step 3 – Configure Twitter Collection

From the SearchBlox Server main page, click the name of your Twitter Collection to go to the Configuration Screen.

How to configure Twitter as a SearchBlox Collection

Here you will be asked to fill out several fields. Four mandatory fields will require information from your Twitter app:

  1. Consumer Key
  2. Consumer Secret
  3. Access Token
  4. Access Token Secret

Where you put Twitter access keys on SearchBlox

After you have added your Twitter Keys and Secrets, you can modify what types of data SearchBlox will index from Twitter. When you have finished modifying your settings, click the “Save Changes” button and return to the SearchBlox main page.

 

Step 3 – Index Your Twitter Collection

After your Twitter Collection has been added to SearchBlox Server, you will want to manually start an index. You can do this right from the Main page by locating the Twitter Collection in your Collections list and clicking the “Index” button.

How to configure Twitter as a SearchBlox Collection

 

Step 4 – Add Twitter Collection to SearchBlox for WordPress plugin

Once SearchBlox Server has indexed Twitter, the Collection should be immediately available to your SearchBlox for WordPress websites.

To verify that these Collections are being included in your WordPress search functions, log into your WordPress website and go to “Search Collections” under the SearchBlox section of the admin menu. There you will see a list of all Collections that the SearchBlox for WordPress plugin has access to.

If no Collections are checked, then the SearchBlox for WordPress plugin includes all Collections in search functions. If one or more Collections are checked, then you will need to check the box next to the recently added website Collection.

Assign collections to include in SearchBlox searches

After making changes, click the “Save Settings” button.

After a few moments, this Collection will be included in WordPress search functions. Searches performed after the inclusion will include Tweets alongside content from other Collections.

how does SearchBlox include Twitter content in search results

Back to Top