Documentation des plugins

Plugins

Le système de plugins permet d’étendre Galette avec des fonctionnalités spécifiques qui ne seraient pas utiles à la plupart des utilisateurs… Les plugins incompatibles seront automatiquement désactivés, auquel cas vous devriez envisager a mise à jour vers une version plus récente.

Chaque plugin est un simple répertoire dans {galette}/plugins/, référez-vous ensuite à la documentation du plugin pour l’installation.

Plugins existants

L’organisation Github héberge tous les plugins. Voyez comment ajouter votre plugin, si vous souhaitez nous rejoindre.

Interface de gestion des plugins

Une interface de gestion des plugins est fournie, vous la trouverez dans le tableau de bord ou le menu configuration. Après avoir téléchargé le(s) plugin(s) dans le dossier plugin de Galette, une liste sera affichée :

Gestion des plugins

Si le serveur web possède le droit en écriture dans le dossier du plugin, vous pourrez activer ou désactiver chaque plugin depuis l’icône en question.

Si un plugin requiert une base de données, vous pourrez lancer les scripts d’installation et de mise à jour depuis l’interface.

Les droits de la base seront vérifiés. À l’inverse de l’installation de Galette, aucune information ne vous sera demandée, puisqu’elles sont déjà présentes depuis l’instance courante.

Modifié dans la version 1.3.0: Chaque plugin a désormais sa propre version de base de données, et se met à jour indépendamment. La page liste d’abord les plugins actifs, puis les inactifs, avec la raison de leur inactivité.

Une icône à côté du nom d’un plugin inactif indique pourquoi il n’est pas actif :

  • Non installé : le plugin a besoin de tables en base de données qui n’ont pas encore été créées. Cliquez sur l’icône de base de données de la colonne Actions pour les installer,

  • Mise à jour requise : les fichiers du plugin sont plus récents que sa base de données. Cliquez sur l’icône de base de données pour lancer la mise à jour,

  • Désactivé explicitement : le plugin a été désactivé depuis cette page, ou depuis la ligne de commande. Cliquez sur l’icône d’activation pour le réactiver,

  • Incompatible avec la version courante : le plugin est prévu pour une autre version de Galette ; cherchez une version plus récente du plugin,

  • Un fichier requis est manquant : les fichiers du plugin sont incomplets ; téléchargez à nouveau le plugin,

  • Version de base de données manquante : Galette ne sait pas quelle version de la base de données du plugin est installée.

Le nom d’un plugin actif ouvre une fenêtre d’informations : version, auteur, routes et droits d’accès.

Avertissement

Sauvegardez votre base de données avant d’installer ou de mettre à jour la base de données d’un plugin, comme avant une mise à jour de Galette lui-même.