Projects

A vtiger plugin which overrides the default site-search functionality to query a sphinx index for string matches instead of using the mysql LIKE operator. This plugin will dramatically improve your vtiger search speeds.

Once installed, this plugin manages itself, and requires almost no configuration or maintenance.

Sphinx Configuration

A sample sphinx server configuration file is included in the download zip (sphinx-server-example.conf). As part of the vtiger plugin installation, the sphinxsearch module will create several mysql views, which are referenced in the included sphinxsearch configuration.

If your vtiger installation utilizes custom fields, you will have to adjust the default views to include those fields. Details on this procedure is a bit outside this introductory guide, but use the manifest.xml included in this zip as a starting point to create your own index views.

vtiger Installation

Assuming sphinx is already installed on your vtiger server, installation is simple. Just install the below module as an admin user, via the vtiger GUI.

The sphinxsearch configuration settings are stored in your vtigercrm/modules/sphinxsearch/sphinxconfig.xml.php, but the default values should be just fine for most installations.

Usage & Configuration

Make sure your sphinx module diagnostics status is Green/Pass , and you're good to go. Just use the site search like you always would.

A note on the UnifiedSearch.php hack...We tried to completely emulate the search functionality using javascript and minor trickery - and not by patching od system files. However, there are a couple of subtle 'bugs' in our implementation that cause vtiger to not always use the accelerated search code. If you'd like, go ahead and cd into your "vtigercrm/modules/Home" directory, and run a "mv UnifiedSearch.php UnifiedSearch.dep.php; ln -s ../sphinxsearch/UnifiedSphinxSearch.php ./". This will ensure all searches are routed to the accelerated search code.

Download

SphinxSearch v 1.00:
sphinxsearch-v1.00.zip