How to install a LOEP plugin

How to install a LOEP plugin

1. Download

First off, we need to download the plugin. A LOEP plugin is expected to be provided as a ZIP file with a folder inside it with the same name as the plugin. For instance, the "loep_stars_private" LOEP plugin can be downloaded here.

2. Extract the ZIP file

We need to extract the ZIP file and move the extracted folder to the /loep_plugins/ folder of the LOEP application.
For a LOEP production instance, the folder should be moved to a folder named "private_plugins" placed at the shared path. Then, the plugin should be added in the private_plugins key of the corresponding deploy xml file.

3. Enable the plugin

We need to enable the plugin in the application_config.yml file. Basically, we need to add the name of the plugin to the plugins key.
If we want new evaluation models or metrics provided by the plugin to be enabled, we need to enable them in the application_config.yml file as well.

4. Install plugin

In order to install the plugin we should execute the following command:

bundle exec rake db:populate:install_plugins

5. Reload

Finally, we need to reload the web server to start working with the new plugin.