How to Enable Plugins

How to Enable Plugins



What are plugins?

Plugins are extra features that can be enabled to enhance the functionality of Koha. Plugins are created by members of the Koha community and as such new ones come out often and established ones may be upgraded. It is up to individual libraries if and how they use these plugins and to ensure they check for new versions of ones they have already on their system. To find out more about plugins search your current version’s manual. Plugins for Koha can be searched for in https://github.com/.

It is important to note that libraries do not have to use any plugins if they are satisfied with how their system operates. If a library does want to utilise a plugin it is vital that they test it on their staging first to be sure it will not negatively impact the performance of their system. If in doubt, don’t. If a library wants to use a plugin but is uncertain about how it will impact their system, or if they do not have a dedicated staging server, they should contact Interleaf Technology directly for guidance. 

Before any plugins can be added to your system, it is necessary to configure your system to allow plugins to be uploaded, the process for which will be outlined in this document.

Step 1 - How to tell if plugins are allowed on your system

If plugins enabled on your system when you go to Koha administration, there should be a heading Plugins. 


Under this heading, there should be a link called Manage plugins.

Clicking this link will bring you to a page with an option to Upload plugin.


If all of this appears on your system, you are set up to upload and configure plugins. 

If this does not appear on your system you will need to contact Interleaf Technology to have the plugins enabled. 

Step 2 - Enabling plugins

Once Interleaf Technology has confirmed that the plugin function has been configured, go to Koha administration > Global system preferences and search for UseKOHAPlugins, which should bring up a system preference of the same name.


​


Switch this setting to Enable.

If after completing these steps you still cannot find the option to upload plugins on your system, contact Interleaf Technology for further advice.


Version History

Version

Date

Detail

Author

1.0

01/06/18

Create doc.

Holly Cooper
2.0
14/05/20
Migrate to Zoho
Holly Cooper
2.115/03/21Adding TOC, clarifying languageHolly Cooper




















Retention Policy

Permanent









    • Related Articles

    • How to install and configure the coverflow carousel plugin on Koha

      Step 1 - Preparing the System To start, contact Interleaf to ensure that the plugin system is enabled in the configuration file on your Koha database. Once this has been confirmed, go to Koha Administration > Global System Preferences > ...

    • How to enable the Print Borrower Notice Plugin

      Setting up print versions of overdue notices notices tends to be time consuming as notices must be configured correctly and may need several edits to ensure they are displaying as you want them. Additionally, printing a bulk of notices is not always ...

    • Force Delete Plugin

      Force Delete Plugin It is very important to note that records deleted using this plugin cannot be retrieved. Unlike records deleted in batch or one at a time at the item or bibliographic screen which may be retrievable from the deleted_biblio table ...

    • Installing GOBI plugin

      How to install the GOBI plugin This plugin is designed to provide an easy integration for the GOBI Library Solutions from EBSCO.   It registers purchase orders into Koha based on the GOBI message it receives. It is intended to serve as a testbed so ...

    • How to install and use the Bywater support plugin

      It is possible to install a plugin that will allow practitioners on the staff interface to ask queries and provide details of issues directly to an email support account from within the Koha application. Step 1 - Download the plugin Go to ...