Plugin system

Koha’s plugin system allows you to add tools, reports, and other functions to Koha that are specific to your library. Plugins are installed by uploading KPZ (Koha Plugin Zip) packages. A KPZ file is just a ZIP file containing the Perl files, template files, and any other files necessary to make the plugin work.

Warning

There is no vetting process by the Koha community for plugins. Each plugin is maintained and tested by its provider and contributors. Use plugins at your own risk.

The plugin system needs to be enabled by a system administrator.

Enabling plugins

To set up the Koha plugin system, you must first make some changes to your installation by editing the koha-conf.xml file.

  • Change <enable_plugins>0</enable_plugins> to <enable_plugins>1</enable_plugins>.

  • Plugin uploads in the staff interface are disabled by default. If you want to allow this, you need to disable this restriction by setting <plugins_restricted>0</plugins_restricted>.

  • Reload the webserver: sudo koha-plack --reload <instancename>

After enabling plugins, you will be able to install and manage them from the Plugins section on the Administration page. After installing a plugin, you will also find Tool plugins on the Tools page and Report plugins on the Reports page.

Installing a plugin repository

In the koha-conf.xml file, there should be a <plugin_repos> tag. This tag is used to tell Koha which Git repositories to search for plugins.

Each individual repository is in a <repo> tag. Inside this tag is the repository’s information.

  • <name> is the name of the company or individual who owns the repository.

  • <org_name> is the username of the company or individual on the Git service.

  • <service> is the Git platform used to host the repository.

Several repositories are available in the default configuration file. Uncomment the ones you want to use.

<plugin_repos>
  <repo>
    <name>ByWater Solutions</name>
    <org_name>bywatersolutions</org_name>
    <service>github</service>
  </repo>
  <repo>
    <name>Theke Solutions</name>
    <org_name>thekesolutions</org_name>
    <service>gitlab</service>
  </repo>
  <repo>
    <name>Open Fifth</name>
    <org_name>openfifth</org_name>
    <service>github</service>
  </repo>
   <repo>
     <name>Solutions inLibro</name>
     <org_name>inLibro</org_name>
     <service>github</service>
 </repo>
</plugin_repos>

Installing and using plugins

See the Plugins section in the Administration chapter of this manual to learn how to install and use plugins in Koha.