Part 4.2: Deploying your plugin

This tutorial demonstrates how to install a plugin that has been packaged into a .tar.gz file onto a Funnelback server.

The steps required will depend on what kind of Funnelback instance the plugin will be installed on to.

This guide utilizes a Vagrant VM with Funnelback installed onto Centos 7. If you already have Funnelback installed locally or a development Funnelback instance hosted on a remote server, you may follow these instructions to install your plugin bundle. Alternatively, you can use the automatic commands below.

Testing with a Vagrant VM

Copy your plugin (title-prefix-plugin-1.0.0.tar.gz file) to the vagrant folder.

From within your VM:

$ sudo su - search
$ cd /vagrant
$ tar -xf title-prefix-plugin-1.0.0.tar.gz -C /opt/funnelback/share/plugins/

This command installs the plugin. Plugins are reloaded automatically every 30 seconds so there may be a slight delay before the plugin takes effect.

Automatically deploying your plugin

When developing your plugin, you might want to have a quicker turnaround between packaging, deploying and testing your plugin. This is possible if you have a local version of Funnelback or a version that can be easily rsynced to. You must also have rsync installed.


If you have a local Funnelback and $SEARCH_HOME is defined you can install the plugin into Funnelback with:

$ mvn clean install -Pinstall-local


If you have access to a remote Funnelback, you must first setup your environment with where to find it:

$ export SEARCH_HOME_REMOTE=/opt/funnelback/
$ export

Then install the plugin with:

$ mvn clean install -Pinstall-remote-rsync
you must have SSH access to the remote server and it must be running an rsync daemon. If you only have SSH access you can scp the .tar.gz file onto the VM then install it with similar commands to those used for the dev VM.

Next steps

The next tutorial shows how to live-test the plugin on your Funnelback server.