Overview

Artifact ID: 7b5b3bf6046ab1150d65f550363dcd7317fc957a9b446dba45721d195a514ea3
Page Name:Configuration
Date: 2021-10-28 01:17:59
Original User: bohwaz
Mimetype:text/x-markdown
Parent: 8b653f34f9c7db836b14fd94527f96222292d419be6c284185c477674b7252ed (diff)
Next c016d875d7fa64d7f2015fa7a2918886abc6ee87baac0bade16ba1ba169459fb
Content

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 et de modifier ses valeurs.

Cette configuration requiert une connaissance basique de PHP.

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) :

  • PrinceXML 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.

Nous conseillons PrinceXML, qui est le plus léger, le plus rapide et génère les PDF les plus jolis, 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.

Si aucun de ces programme n'est trouvé, une erreur sera affichée.

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 %2$s %1$s'

%1$s sera remplacé par le chemin du fichier HTML, et %2$s par le chemin du fichier PDF.

Si vous n'avez pas la possibilité d'installer un de ces programmes, 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.