Plugin system

Le système de plugin de Koha vous permet d’ajouter à Koha des outils et des rapports supplémentaires spécifiques à votre bibliothèque. Les plugins s’installent en téléchargeant les packages KPZ (Koha Plugin Zip). Un fichier KPZ est simplement un fichier zip contenant les fichiers perl, les fichiers de templates, et tout les autres fichiers nécessaires au fonctionnement du plugin.

Avertissement

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.

Le système de plugin doit être activé par l’administrateur du système.

Configuration

Pour configurer le système de plugin de Koha, vous devez d’abord effectuer des changements dans votre installation.

  • Changez <enable_plugins>0</enable_plugins> en <enable_plugins>1</enable_plugins> dans votre fichier koha-conf.xml

  • Redémarrer votre serveur web

On the Tools page you will see the Tools Plugins and on the Reports page you will see the Reports Plugins.

Installing a plugin repository

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

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

  • <name> is the name of the company or individual whose repository this is.

  • <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. You can uncomment one or all.

<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>PTFS Europe</name>
    <org_name>ptfs-europe</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.