Managing extensions and plugins

This feature is not available to users of the Squiz Experience Cloud version of Funnelback.

Extensions within Funnelback are supplied as downloadable plugins which expand the available functionality available when implementing Funnelback.

A Funnelback plugin is a set of java libraries that can be enabled and configured to be executed during collection updates or at query time. These scripts will be run as the search user and have access to the file system.

Getting a plugin

Plugins need to be installed on your server before they can be enabled on a collection or used. Plugins are external to the Funnelback product and can be developed by anyone. It is recommended that only plugins which you trust are deployed on to the server. There are two ways to get a plugin:

Installing a plugin

Plugins are distributed as a tar.gz file. To install a plugin, extract the contents of the package as the search user:

tar -xf <plugin.tar.gz> -C $SEARCH_HOME/share/plugins/

Plugins are versioned within the tarball and the versions are organised by sub-folder.

e.g. version 1.2.3 of the 'sample' plugin would appear under: $SEARCH_HOME/share/plugins/sample/1.2.3/.

Reloading changes

Under the modern UI changes to plugins will be reloaded every 30s under the authenticated admin context (usually port 8443). Under the other contexts (usually ports 443 and 80) the plugins are reloaded every 4 minutes.

Plugins are not reloaded during an update.

A plugin being reloaded does not mean that indexes will be updated. Plugins which update indexes will only affect the index after the next update.

See also