Documentation

La base de connaisance complète sur ARender - Comment l’installer et le configurer pour répondre à vos besoins

Prérequis

Système d’exploitation

Catégorie Pré-requis
Windows Windows 2012 Server R2 ou supérieur
Linux Linux Noyau 2.6 ou supérieur, glibc 2.14 ou supérieur. Distributions Linux correspondant à nos pré-requis logiciels : RedHat (7+), CentOS (7+), Debian (8+), Ubuntu (14.04+), Amazon Linux AMI (2016.09+)

Configuration matérielle

Catégorie Minimum Conseillé
Nb Serveur 1 2 (Haute disponibilité)
RAM 8Go 16Go
CPU (vCPU) 4 8
Type de CPU 64Bits 64Bits
Stockage 20Go Le maximum entre 20Go et une capacité permettant de stocker une journée de documents temporaires

Configuration des ports

Les différents ports des micro-services doivent être libre. Ces ports sont :

Service Protocols Port d’écoute par défaut
Service broker HTTP/HTTPS 8761
Distant file storage HTTP 8081
Text handler HTTP 8899
Renderer HTTP 9091
Converter HTTP 19999

Configuration logicielle

Merci d’installer tous les logiciels ci-après

Type de document Logiciel Pré-requis
Tous Java Runtime JRE 1.8 64 bits Minimum, JDK conseillé (1.8.0_252 is the validated version). Les JRE OpenJDK et/ou Oracle sont préconisées, la JRE IBM J9 est non supportée.
Documents Office LibreOffice ou Microsoft Office LibreOffice 5 et supérieur conseillé. Attention sur RHEL/CentOS(6) l’installation de LibreOffice 5 nécessite la présence de la librairie libGL.so.1. Libreoffice 6 et supérieur nécessite ARender 3.1.9 et supérieur. Microsoft Office 2013 ou plus récent.
Images ImageMagick ImageMagick 7 ou supérieur (Sous Windows, validez que le binaire nommé convert.exe existe bien dans votre installation Imagemagick, si non, créez le en lien nommé magick.exe)
Mails et HTML WKHtmlToPdf wkhtmltopdf 0.12.5 ou supérieur
Vidéos, Audios et GIFs FFmpeg FFmpeg 2.8.15 ou supérieur
Attention
Le serveur de rendition vérifie désormais que la JVM est 64 bits et va s’arrêter sinon. Cette erreur pourra se lire dans les logs ou la console selon le mode de démarrage de la rendition.

Droits d’accès

Pour l’installation

  • L’utilisateur doit avoir les droits pour dézipper le contenu du zip de la rendition dans le dossier voulu.
  • L’utilisateur doit pouvoir également créer un service.

Pour l’éxecution

  • L’utilisateur démarrant le service doit avoir les droits d’accès aux fichiers du serveur de rendition et autres logiciels tiers requis, ainsi que les droits d’execution.

Installer des logiciels pour ARender en 4.0

Dans ARender 4.0, les logiciels requis par notre micro service de conversion de document sont automatiquement cherchés dans le chemin PATH du serveur.

Pour les utilisateurs Windows, nous vous recommandons d’utiliser Chocolatey pour gérer cela facilement: https://chocolatey.org/

Pour les utilisateurs Unix / Linux, veuillez installer ces packages à partir de vos packages de distribution officiels car ils placent souvent les fichiers binaires dans les dossiers appropriés. Si vous le faites manuellement, veuillez mettre à jour vos variables PATH en conséquence.

Si vous souhaitez supporter les mails dans ARender, merci d’installer et de mettre dans le PATH wkhtmltopdf. Si votre serveur ne possède pas de serveur X (Linux uniquement), veuillez installer xvfb et lancer les commandes suivantes:

echo -e '#!/bin/bash\nxvfb-run -a --server-args="-screen 0, 1024x768x24" /usr/bin/wkhtmltopdf -q $*' > /usr/bin/wkhtmltopdf.sh
chmod a+x /usr/bin/wkhtmltopdf.sh
ln -s /usr/bin/wkhtmltopdf.sh /usr/local/bin/wkhtmltopdf

Si vous souhaitez supporter les fichiers Office, vous pouvez configurer Libreoffice et/ou Microsoft Office si vous êtes sous Windows. Vous pouvez vous référer à la section suivante pour Microsoft Office. Pour Libreoffice, il suffit d’installer Libreoffice et de s’assurer que les binaires LibreOffice sont dans le PATH

Si vous souhaitez supporter les fichiers image (PNG,JPEG, etc…) veuillez installer imagemagick sur votre système et inclure ses binaires dans le PATH.

Si vous souhaitez supporter les fichiers vidéo (MOV, AVI, MPG, etc…) veuillez installer ffmpeg sur votre système et inclure ses binaires dans le PATH.

Configurer le serveur de rendition pour Microsoft Office

ARender permet également d’utiliser Microsoft Office pour la prise en charge des documents Office.

Nous possédons un outil permettant de valider que les prérequis ont été installé correctement. Si vous avez un doute, téléchargez l’outil et lancez le en Administrateur : AromsCheck

Pré-requis

.Net 4.5 : http://www.microsoft.com/fr-fr/download/details.aspx?id=30653

Microsoft Visual C++ redistributable 2010 : https://www.microsoft.com/fr-fr/download/details.aspx?id=14632

Microsoft Visual C++ redistributable 2008 : https://www.microsoft.com/en-us/download/details.aspx?id=15336

Office 2013 (recommandé 2016). Possibilité de choisir Office 365 si le serveur sur lequel sera installé Office aura accès au net. Nous recommandons de garder l’installation d’Office à jour.

Windows Server 2012 R2 et plus minimum. Pour une meilleure expérience et installation nous recommandons de garder vos serveurs Windows à jour de toute mise à jour majeure/service pack.

Attention
  • Il est impératif de lancer la rendition avec un compte utilisateur - administrateur ou non - (Services > ARender Rendition Service > Connexion) qui ouvre Microsoft Office sans soucis et sans pop-ups. Les pop-ups empêchent le bon fonctionnement d’Office et donc de notre rendition pilotée.
  • Pour la configuration des conversions de fichiers Excel, vérifiez que l’utilisateur possède une imprimante par défaut configurée et fonctionnelle (par exemple, conversion vers XPS) afin de pouvoir faire des opérations de travail sur les pages des feuilles Excel.
  • N’utiliser pas l’imprimante proposé par défaut, cette imprimante sera seulement utilisé pendant la connexion à distance sur le serveur et s’arrêtera dès que vous le quitterez.
Création des dossiers système

C:\Windows\System32\config\systemprofile\Desktop

C:\Windows\SysWOW64\config\systemprofile\Desktop

Configurer les propriétés Microsoft Office dans ARender

Il est possible de configurer le rendu des documents générés par ARender via Microsoft Office. Pour cela, il faut modifier le fichier aroms.properties situé dans le dossier modules\TaskConversion\aroms2pdf de votre installation de ARender Rendition.

Voici la liste des propriétés modifiables :

Propriété Valeur par défaut Détail
PDF/A false PDFs généré par ARender sont des PDF/A
processAutoKill false Termine les anciens processus Office au démarrage de Aroms
TimeoutS 120 Temps maximum de conversion pris par ARender pour generer un PDF via MS Office. Au délà de ce temps, le processus est terminé
AromsHost http://localhost:8000/ URL sur laquelle Aroms est exposé
LockFields false Désactive la mise à jour des champs variable (comme les dates) du document Office
IgnorePrintAreas true Désactive l’impression des lignes vides
FitSheetOnOnePage true True: MS Office va imprimer le document sur une seule page. False: Comportement par défaut de MS Office (découpage en plusieurs page si le document est trop grand).