Plugins

This section is used to manage all types of plugins.

Important

Before using plugins, make sure that they are enabled in the configuration file.

Note

Only staff with the manage permission, the configure permission, or the admin permission (or the superlibrarian permission) will see this section.

See also the tool plugins and report plugins sections.

Get there: More > Administration > Plugins

If there are any administrative plugins installed, they will appear under this section.

Note

Only staff with the admin permission (or the superlibrarian permission) will be able to use administrative plugins.

Managing plugins

This section is used to view, manage and configure all types of plugins.

Note

Only staff with the manage permission (or the superlibrarian permission) will be able to install and uninstall plugins.

The page will show all currently installed plugins.

If you have a lot of plugins, you can view a subset by clicking ‘View plugins by class’.

Installing a plugin

To install a new plugin manually,

Click ‘Upload plugin’.

Choose the KPZ file on your computer and click ‘Upload’.

If you configured external plugin repositories, you will have a search box at the top of the page to search these repositories and install directly from there without having to download and upload the KPZ file. To install a plugin from a repository,

Enter a search term in the search box.

Click ‘Install’ to the right of the plugin.

Some plugins might need to be enabled before usage.

To enable a plugin,

Click the ‘Actions’ button to the right of the plugin and choose ‘Enable’

Using a plugin

All plugins are different. Some might need configuration before usage, others are simply run.

Click the ‘Actions’ button and choose ‘Configure’ or ‘Run’.

Follow the instructions issued by the plugin’s creator.

Note

Only staff with the configure permission (or the superlibrarian permission) will be able to access plugin configuration.

Disabling a plugin

If you need to temporarily stop the plugin from taking effect, you can disable it.

Click the ‘Actions’ button to the right of the plugin and choose ‘Disable’

This will not uninstall the plugin. It will remain installed, but will not have any effect on your Koha installation.

Deleting a plugin

To delete or uninstall a plugin,

Click the ‘Actions’ button to the right of the plugin and choose ‘Delete’

This will remove the plugin from your Koha installation. Any action or effect it had will stop. If you need to, you can reinstall it later, provided it is still available.