FR

Documentation

Mettre en place Modèles PDF Créatifs

Installation, configuration et utilisation, pas à pas.

Installer le module dans Dolibarr

  1. Téléchargez le fichier ZIP du module (nommé module_xxx-version.zip), par exemple depuis le Dolistore.
  2. Dans Dolibarr, ouvrez Accueil > Configuration > Modules/Applications > Déployer un module externe.
  3. Envoyez le fichier ZIP, puis activez le module dans la liste des modules.
  4. Essayez d’abord sur une copie de vos données, et gardez une sauvegarde avant toute mise à jour.

Prérequis : un moteur PDF

Modèles PDF Créatifs dessine vos documents en HTML et CSS, comme une page web. Pour en faire un PDF identique à ce que montre l'éditeur, il s'appuie sur un moteur de rendu installé à côté de Dolibarr. Trois moteurs sont pris en charge :

  • Gotenberg (conseillé) : un service Docker qui embarque Chromium. Le PDF est identique à l'éditeur.
  • Chrome ou Chromium installé sur le serveur : le même rendu, sans Docker. PHP doit pouvoir lancer des programmes (fonction exec autorisée).
  • TCPDF, intégré : aucune installation, mais un CSS très limité. Il sert de moteur de secours, et les designs premium du catalogue ne sont pas rendus correctement avec lui.

L'onglet Moteurs PDF de la configuration du module détecte les moteurs présents sur votre serveur et donne les mêmes exemples d'installation que cette page.

Les commandes qui suivent se lancent dans un terminal du serveur, avec des droits d'administration. Une mauvaise manipulation peut rendre le serveur instable ou exposer un service sur le réseau : en cas de doute, faites appel à votre hébergeur, à un administrateur système, ou à notre accompagnement.

Installer Gotenberg avec Docker (conseillé)

La configuration conseillée en production : écoute locale uniquement, authentification, et Chromium sans accès réseau, car toutes les ressources du document sont envoyées avec le HTML. Créez ce fichier en remplaçant le mot de passe :

# /opt/gotenberg/docker-compose.yml
services:
  gotenberg:
    image: gotenberg/gotenberg:8
    restart: unless-stopped
    ports:
      - "127.0.0.1:3000:3000"          # local access only
    command:
      - "gotenberg"
      - "--api-timeout=60s"
      - "--api-enable-basic-auth"       # reads the 2 environment variables below
      - "--chromium-deny-private-ips"   # Chromium cannot reach the internal network (SSRF)...
      - "--chromium-deny-public-ips"    # ... nor Internet: all resources are sent with the HTML
      - "--log-level=warn"
    environment:
      GOTENBERG_API_BASIC_AUTH_USERNAME: dolibarr
      GOTENBERG_API_BASIC_AUTH_PASSWORD: "change-me"

Démarrez le service, puis vérifiez qu'il répond :

cd /opt/gotenberg && docker compose up -d
curl -s http://127.0.0.1:3000/health
curl -s http://127.0.0.1:3000/version

Si Dolibarr tourne lui-même dans Docker, l'URL de Gotenberg est http://gotenberg:3000 (même réseau). Prévoyez environ 1 Go de mémoire pour Gotenberg et mettez l'image à jour régulièrement avec docker compose pull, car elle embarque Chromium.

Installer Gotenberg pour un essai rapide

Sur un poste de développement, une seule commande suffit. Elle n'est pas faite pour la production : pas d'authentification, et sans l'adresse 127.0.0.1 le port serait ouvert sur toutes les interfaces.

docker run --rm -p "127.0.0.1:3000:3000" gotenberg/gotenberg:8

Installer Chrome ou Chromium sur le serveur

Le même rendu que Gotenberg, sans Docker. PHP doit pouvoir lancer des programmes (fonction exec autorisée). Si le programme n'est pas trouvé, indiquez son chemin dans l'onglet Paramètres du module.

apt install chromium        # or google-chrome-stable from the Google repository
chromium --headless=new --version

Installer un convertisseur pour les vignettes du catalogue

Le catalogue des designs montre la première page de chaque modèle en vignette. Un seul convertisseur suffit. Sans lui, le catalogue affiche une image de remplacement, et l'aperçu PDF de chaque design reste disponible.

pdftoppm (conseillé) : le plus simple et le plus léger. PHP doit pouvoir lancer des programmes et, si open_basedir est utilisé, accéder au dossier /usr/bin.

apt install poppler-utils   # dnf install poppler-utils on RHEL / Rocky / Fedora
pdftoppm -v

Ghostscript : souvent déjà présent sur les serveurs, avec les mêmes conditions.

apt install ghostscript
gs --version

Imagick : sans lancer de programme, mais ImageMagick refuse les PDF par défaut. Il faut les autoriser en lecture, ce qui vaut pour tout ce qui utilise ImageMagick sur le serveur : à préférer seulement si la fonction exec est désactivée.

apt install php-imagick ghostscript
# ImageMagick refuses PDF by default: allow reading them (policy.xml of ImageMagick 6 or 7)
sed -i 's/rights="none" pattern="PDF"/rights="read" pattern="PDF"/' /etc/ImageMagick-*/policy.xml
# then restart PHP: systemctl restart php8.x-fpm (or apache2, the PHP service of your server)

Configurer le module

  1. Dans Dolibarr, ouvrez Accueil › Configuration › Modules, puis la configuration de Modèles PDF Créatifs.
  2. Onglet Paramètres : choisissez le moteur principal (Gotenberg ou Chromium) et le moteur de secours, puis renseignez l'URL du serveur Gotenberg, son identifiant et son mot de passe.
  3. Onglet Moteurs PDF : cliquez sur « Tester ». Le document de démonstration (flex, grille, tableau long, QR code, en-tête et pied numérotés) doit sortir sans erreur.
  4. Ouvrez un devis ou une facture : vos modèles apparaissent dans la liste des modèles PDF de la fiche, à côté des modèles standards.