Plugins add functionality to Koha outside of its core code to address specific needs such as incorporating vendor integrations or facilitating custom processes and workflows. Frequently-used plugins include EDI plugins for different vendors, vendor-specific notice integrations, the Batch patron permission modifier, and Coverflow (a customizable cover image carousel) for the Koha OPAC.
Installation and updates
To install a plugin or see what plugins are already installed on your site, start in Administration > Manage plugins. This will bring you to a table showing your existing plugins:
The table can be sorted by any column by clicking on its header or searched using the 'Search' box. You can also filter the table by plugin type with 'View plugins by class':
Installing new plugins
To install a new plugin, search for it by name or keyword in 'Search for plugins':
In search results, the plugin name links to its page in GitHub. ByWater Solutions recommends reviewing plugins' GitHub page for important information about configuration and use.Click 'Install' to bring the plugin into your site:
The screen will refresh after a few moments, and then your plugin will be ready to configure.
'Search for plugins' searches a repository of plugins written and maintained by Developers from ByWater Solutions, Theke, and OpenFifth. These plugins are regularly updated to ensure ongoing security, compatibility, and performance. Available plugins can also be browsed from ByWater Solutions' GitHub at https://github.com/bywatersolutions.
Updating plugins
If a plugin isn't working as expected, the fix is often as simple as updating it to the latest version. To see if your plugin has a newer version available, search for the plugin in 'Search for plugins'. Next, compare the version numbers to ensure you have the latest release:
If you don't have the most recent release, as in the example above, click 'Install' on the search result. Your configuration/settings will be maintained as the plugin updates and background processes are refreshed. When the update is complete, you will see that the version number in your plugins table has updated to the latest version.
If updating your plugin to the most recent version does not resolve your issue, please submit a ticket with details for troubleshooting.
If you are interested in writing your own plugin, this Koha Community post has details on requirements and best practices: Plugins anyone?
The Plugins channel in the Koha Community Mattermost is a useful resource for discussing plugins. Note that your code will need to be publicly available somewhere such as GitHub if you would like to ask community members to review it.
To iterate, test, and debug plugins created by your library/organization, ByWater Solutions strongly recommends using a dedicated development environment such as koha-testing-docker instead of your production or test server. Instructions for setting up a koha-testing-docker instance are available at https://gitlab.com/koha-community/koha-testing-docker.
ByWater Solutions is not able to troubleshoot or debug plugins that are installed from sources other than the 'Search for plugins' repository (https://github.com/bywatersolutions), including 'vibe-coded' plugins or other plugins created by your library/organization.