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, where you have SSH access, you may follow these instructions to install your plugin bundle. Alternatively, you can use the automatic commands below.

Testing with a Vagrant VM (manual deployment)

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

From within your VM:

$ sudo su - search
$ cd /vagrant
$ tar -xf title-prefix-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.

Testing with a plugin development Vagrant VM (scripted deployment)

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

From the vagrant folder within your terminal:

$ sh ./stage/scripts/copy-custom-plugins.sh

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

Next steps

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