Install a Search Client in Khoros (Lithium)

Find discussions and posts faster on Khoros boards. This article walks you through the process of installing a SearchUnify search client on a Khoros board.

---

Download a Khoros Search Client

1. Refer to How to Download a Search Client?
2. Extract files from the zipped search client.

   

---

Sign Into Khoros and Navigate to Studio

1. Sign into your Khoros community as an admin.
2. Click Community Admin.

   

3. Enter Studio.

   

---

Create a Khoros Component

1. Click New Component in Components.

   

2. Enter a name and click Create.

   

3. From the files extracted after downloading the search client, open searchUnify_Component with a text editor and copy the code.
4. Paste the code in Component Content and press Save.

   

---

Set Up Three Endpoints

1. Set up an endpoint connect SearchUnify with your community

   1. Click Endpoints.

      

   2. Click New Endpoint.

      

   3. Name the endpoint in Title and click Save.

      

   4. From the files extracted after downloading the search client, open searchUnify_Endpoint with a code editor.

      

   5. Copy the code.

      

   6. Paste the code in View Content and press Save.

      

   7. Copy the name of the endpoint.

      

   8. Return to Components.

      

   9. Open the component that you have just created.

      

   10. Replace <your endpoint name> with the name of the endpoint you had copied in step vii.

       

   11. Press Save.

       

2. Set up an endpoint to gather search analytics

   1. Click Endpoints.

      

   2. Click New Endpoint.

      

   3. Name the endpoint in Title and click Save.

      

   4. From the files extracted after downloading the search client, open searchUnify_live_counts with a code editor.

      

   5. Copy the code.

      

   6. Paste the code in View Content and press Save.

      

   7. Copy the name of the endpoint.

      

   8. Return to Components.

      

   9. Open the component that you have just created.

      

   10. Replace <your second endpoint name> with the name of the endpoint you had copied in step vii.

       

   11. Press Save.

       

3. Set up an endpoint to provide search recommendations

   1. Click Endpoints.

      

   2. Click New Endpoint.

      

   3. Name the endpoint in Title and click Save.

      

   4. From the files extracted after downloading the search client, open searchUnify_Recommendations with a code editor.

      

   5. Copy the code.

      

   6. Paste the code in View Content and press Save.

      

   7. Copy the name of the endpoint.

      

   8. Return to Components.

      

   9. Open the component that you have just created.

      

   10. Replace <your_third_endpoint_name> with the name of the endpoint you had copied in step vii.

       

   11. Press Save.

       

---

OPTIONAL. Create a New Khoros Page

The Khoros component that you have just created is inserted into a Khoros page. You can select one of your existing community pages to host a search bar and search results, or create a new one. This section explains how to create a page in Khoros from scratch.

1. Click Page, and then New.

   

2. Enter a page name in New Page Name prefixed by ForumPage., select One Column from the Page Layouts dropdown, and click Create.

   

---

Insert SearchUnify Component in a Khoros Page

1. Expand the Custom Components menu.

   

2. Click to add the component to the page you have selected or created.

   

3. Drag the component from common-header to main-content and press Save.

   

---

Activate the Page

1. Navigate to Admin.

   

2. Click Content.

   

3. Click Custom Pages.

   

4. Select a page from the Forum Page dropdown and click Save.