# Search Plugin Readme

## Overview

The search plugin adds Jabber Search XEP-0055 capabilities to Openfire. This plugin is designed to work with various Jabber clients to allow other users to search for users currently registered on the same server they are.

## Installation

Copy the file, "search.jar" into the plugins directory of your Openfire installation. The plugin will then be automatically deployed. To upgrade to a new version: 1) go to the plugin screen of the Admin Console, 2) click on the delete icon on the same row as the currently installed search plugin, 3) copy the new search.jar into the plugins directory of your Openfire installation.

## Configuration

The search plugin is configured via the "Search Service Properites" sidebar item located under the "Server" tab in the Openfire Admin Console. By default, after the search plugin has been deployed all of its features are enabled. To enable or disable the plugin select the appropirate radio button and then click on the "Save Properties" button. To change the service name enter the new name for the service and then click on the "Save Properties" button. To disable a field from being searched by clients un-check the corresponding checkbox and click on the "Save Properties" button.

## Using the Plugin

Use of this plugin varies from client to client; however, basic instructions for accessing the search screen for some of the more popular clients are listed below. On the search screen there is a single textfield with three checkboxes. In the textfield enter all or part of the user's name, username and/or email that you want to find. As an example, if you want to find your friend John but don't know if his last name is spelled "Smith" or "Smyth", try entering "John S*" in the search field and making sure the name checkbox is selected. The "*" symbol acts as a wildcard so your search might return not only "John Smith" but all the users whose name begins with "John S", i.e. "John Slater", "John Salazar", etc.

- Admin Console - Navigate to the "Advance User Search" sidebar item located in under the "Users/Groups" tab.
- Spark - Use the search field along the bottom portion of the main Spark window.
- Exodus - After clicking on the magnifying glass with the red "+" sign, a screen will appear displaying the search service that will be used which will be used. Click on the "Next" button and the search screen will be visible.
- JAJC - After clicking on the "Jabber Browser" icon (the third icon from the left), a Jabber browser screen will appear and on the right-hand side, there will be a list of services. Double-click on the "User Search" entry and a new screen will appear. Finally, on the left-hand side of the screen, click on the "Search" item to view the search screen.
- Pandion (v2.1.2) - From the "Actions" menu click on "Add a contact...", on the screen that appears makes sure the "I want to search for someone." radio button is selected and then click on the "Next >" button to view the search screen.
- Psi - On the lower left-hand corner of the client, click on the main Psi toolbar, select "Service Discovery", and click on your username. After the service discovery windowappears, select the "User Search" entry and click on the magnifying glass at the top of the window to view the search screen.