Skip to content
This repository has been archived by the owner on May 3, 2020. It is now read-only.

Plug ins

Jump to bottom
Leon Johnson edited this page May 8, 2018 · 2 revisions

Plug-in Information

Plug-ins are a lightweight means of prototyping functionality or accessing data installed in Serpico.

The officially supported plug-ins are in the SerpicoPlugins project. The wiki for this project has up to date documentation.

Installation

Developer Installation

If you have installed Serpico via GitHub then the easiest way to install plug-ins is to

  • Clone the SerpicoPlugins project from the Serpico root directory

Plug-ins must be installed in a directory called 'plugins' in the root directory. [from the root directory of Serpico, e.g. /home/egon/Serpico/]

git clone https://github.com/SerpicoProject/SerpicoPlugins.git plugins
  • Enable the plugins you want in
https://IP:8443/admin/admin_plugins

Pre-Built Version

If you downloaded and installed Serpico from the releases tab, you can install a zipped version of the plugin.

  • Enable an admin user the plug-in permission

By default no user has the ability to upload a zip file containing the plug-in. Because this permission is so powerful it requires an administrator account and the permission must be enabled from the CLI.

ruby scripts/give_plugin_access.rb administrator_username
  • Create a zip file containing the plug-in

A zip file must contain a single plug-in. For example, to zip up the "ExtraFindings" plugin and install you would:

git clone https://github.com/SerpicoProject/SerpicoPlugins.git
cd SerpicoProject/ExtraFindings
zip -r extra.zip *
  • Upload the plug-in

Go to https://IP:8443/admin/admin_plugins. You should see the upload zip file at the bottom of the page like shown below.

Clone this wiki locally