Configuration

Toute la configuration par le webmaster / hébergeur se fait au moyen du fichier config.local.php situé à la racine de l'installation.

Normalement ce fichier est créé automatiquement à l'installation et contient une clé secrète utilisée pour sécuriser les formulaires.

Les autres directives possible sont décrites dans le fichier config.dist.php également présent à la racine. Il suffit de recopier la directive indiquée vers le fichier config.local.php et de modifier ses valeurs.

Cette configuration requiert une connaissance basique de PHP.

Désactivation des mises à jour automatiques

Si vous désirez ne pas permettre aux utilisateurs (administrateurs) de procéder à la mise à jour, positionnez la constante ENABLE_UPGRADES à false.

Utilisation du cron

Par défaut le logiciel lance les tâches automatisées (sauvegarde automatique, envoi des rappels de cotisation, etc.) quand un membre se connecte. Si aucun membre ne se connecte pendant un temps, aucune tâche ne sera lancée.

Il est recommandé de plutôt mettre en place une tâche cron pour lancer ces tâches automatisées.

Pour cela dans le fichier config.local.php il faut positionner la constante USE_CRON à true :

const USE_CRON = true;

Et créer un cron système comme suit :

@daily php /var/www/garradin/scripts/cron.php

En modifiant le chemin d'accès à Garradin évidemment :)

Création de documents en PDF

Garradin permet de créer des documents en PDF. Pour cela vous devez avoir installé un programme qui permet de convertir du HTML en PDF.

Par défaut, Garradin essaye de détecter si les programmes suivants sont installés (dans l'ordre) :

  • Prince (non libre) qui dispose d'une licence d'utilisation gratuite mais qui ajoutera un petit logo (discret) sur chaque document généré, il y a aussi des licences payantes ;
  • le navigateur web Chromium (sous Debian : apt install chromium) ;
  • wkhtmltopdf ;
  • weasyprint.

Si aucun programme n'est trouvé, Garradin affichera le message d'erreur suivant :

Aucun programme de création de PDF trouvé, merci d'en installer un.

Nous conseillons Prince, qui est le plus léger, le plus rapide, et qui propose le meilleur rendu. Les autres peuvent avoir des problèmes de rendu, dû au fait qu'ils n'ont pas été conçus pour faire du média papier en premier lieu.

La génération de PDF dans Garradin n'est testée au développement que dans Prince et Chromium. Les autres programmes peuvent générer des erreurs de rendu.

Si vous utilisez Prince, un message indiquant son utilisation sera affiché dans les emails contenant des PDF générés, conformément à la licence de Prince.

Si vous n'avez pas la possibilité d'installer un de ces programmes (par exemple si votre hébergeur ne le permet pas), vous pouvez utiliser l'extension DomPDF qui utilise la bibliothèque DomPDF pour générer des PDF. Notez que son rendu est moins fidèle et des bugs de rendu peuvent se produire.

Si vous disposez d'un autre programme de création de PDF, vous pouvez personnaliser la constante PDF_COMMAND dans config.local.php.

C'est aussi conseillé de manière générale si vous faites beaucoup de génération de PDF, car cela évitera l'étape de détection de programme de conversion HTML vers PDF, qui est un peu coûteuse (ouvre jusqu'à 4 process).

Exemple :

const PDF_COMMAND = 'wkhtmltopdf';

Remarque pour windows

La recherche de programmes externes ne fonctionne pas ; il faut donc impérativement positionner la constante PDF_COMMAND comme indiqué ci-dessus ; de plus, il faut ajouter le chemin complet vers cette commande dans la variable path système (et pas celle de l'utilisateur) puis redémarrer le PC.