Lancement

Lancement manuel

Pour lancer de manière ad-hoc les applications FlowerDocs GUI et FlowerDocs Core, il suffit de lancer les commandes suivantes :


./flower-docs-gui-webapp-2.5.4.7.jar 


./flower-docs-core-webapp-2.5.4.7.jar

Si le répertoire de configuration est différent du répertoire d’exécution, ajouter le paramètre --spring.config.additional-location=${FD_HOME}.

Installation en service

Linux

Les applications FlowerDocs peuvent être installées simplement en tant que service Linux init.d ou systemd.

Dans cette section, il est supposé que les JAR flower-docs-gui-webapp-2.5.4.7.jar et flower-docs-core-webapp-2.5.4.7.jar sont placés dans le dossier /opt/flowerdocs. Ce dossier est également utilisé comme répertoire de configuration.

Service init.d

Afin d’installer les applications FlowerDocs en tant que service init.d, il suffit de créer un lien symbolique dans le répertoire /etc/init.d :


chmod +x /opt/flowerdocs/flower-docs-gui-webapp-2.5.4.7.jar
ln -s /opt/flowerdocs/flower-docs-gui-webapp-2.5.4.7.jar /etc/init.d/gui


chmod +x /opt/flowerdocs/flower-docs-core-webapp-2.5.4.7.jar
ln -s /opt/flowerdocs/flower-docs-core-webapp-2.5.4.7.jar /etc/init.d/core

Avec ce type de service, l’utilisateur auquel appartient le JAR est utilisé pour exécuter l’application. Un fichier de log par application est alimenté dans le répertoire /var/log.

Afin que le service démarre automatiquement au démarrage du système :


update-rc.d gui defaults


update-rc.d core defaults

Si le service n’est pas trouvé, il peut être nécessaire d’exécuter la commande :

systemctl daemon-reload

Service systemd

Pour installer les applications FlowerDocs en tant que service systemd, les scripts gui.service et core.service doivent être créés dans le répertoire /etc/systemd/system tel que :


[Unit]
Description=FlowerDocs GUI
After=syslog.target

[Service]
User=flowerdocs
ExecStart=/opt/flowerdocs/flower-docs-gui-webapp-2.5.4.7.jar
SuccessExitStatus=143

[Install]
WantedBy=multi-user.target


[Unit]
Description=FlowerDocs Core
After=syslog.target

[Service]
User=flowerdocs
ExecStart=/opt/flowerdocs/flower-docs-core-webapp-2.5.4.7.jar
SuccessExitStatus=143

[Install]
WantedBy=multi-user.target

Afin que le service soit démarré automatiquement par systemd, exécuter les commandes suivantes :


systemctl enable gui.service


systemctl enable core.service

Configuration de la JVM

Pour configurer la JVM de l’application lancée par le service Linux, il est nécessaire d’ajouter un fichier de configuration dans le même répertoire que le JAR. Ce fichier de configuration doit avoir le même nom que le JAR avec l’extension conf.

Ce fichier de configuration permet, par exemple, d’utiliser un répertoire de configuration différent du répertoire d’exécution en définissant la propriété de la JVM spring.config.additional-location :


echo RUN_ARGS=\"--spring.config.additional-location=/var/flowerdocs/conf\"  > /opt/flowerdocs/flower-docs-gui-webapp-2.5.4.7.conf


echo RUN_ARGS=\"--spring.config.additional-location=/var/flowerdocs/conf\"  > /opt/flowerdocs/flower-docs-core-webapp-2.5.4.7.conf

Commandes

Pour lancer les services, il suffit ensuite de lancer les commandes :


service gui start


service core start

Les autres commandes standards sont également supportées : status, stop ou restart.

Windows

Les applications FlowerDocs peuvent être installées en tant que service Windows à l’aide de l’utilitaire winsw.


Avant de commencer, vérifier que le framework .Net est installé et télécharger la distribution winsw adapté au système cible.

  • Renommer le fichier winsw .exe en flowerdocs-gui-service.exe
  • Créer un fichier vide flowerdocs-gui-service.xml
  • Renommer le fichier winsw .exe en flowerdocs-core-service.exe
  • Créer un fichier vide flowerdocs-core-service.xml

Afin de configurer le service Windows, éditer le fichier de configuration .xml tel que :


<service>
  <id>flowerdocs-gui</id>
  <name>FlowerDocs GUI</name>
  <description>This service manages FlowerDocs GUI.</description>
  <env name="FLOWER_DOCS_CONFIG_DIR" value="%BASE%"/>
  <executable>java</executable>
  <arguments>-Xmx512m -jar "%BASE%\flower-docs-gui-webapp-2.5.4.7.jar"</arguments>
  <log mode="roll-by-size-time">
    <sizeThreshold>10240</sizeThreshold>
    <pattern>yyyyMMdd</pattern>
    <autoRollAtTime>00:00:00</autoRollAtTime>
  </log>
</service>


<service>
  <id>flowerdocs-core</id>
  <name>FlowerDocs Core</name>
  <description>This service manages FlowerDocs Core.</description>
  <env name="FLOWER_DOCS_CONFIG_DIR" value="%BASE%"/>
  <executable>java</executable>
  <arguments>-Xmx512m -jar "%BASE%\flower-docs-core-webapp-2.5.4.7.jar"</arguments>
  <log mode="roll-by-size-time">
    <sizeThreshold>10240</sizeThreshold>
    <pattern>yyyyMMdd</pattern>
    <autoRollAtTime>00:00:00</autoRollAtTime>
  </log>
</service>

Si le répertoire de configuration est différent du répertoire d’exécution, ajouter le paramètre -Dspring.config.additional-location=${FD_HOME} dans la balise arguments.


Pour lancer l’installation en tant que service :

  • Ouvrir un invite de commandes en tant qu’administrateur
  • Aller dans le dossier dans lequel se trouvent les exécutables et les fichiers de configuration .xml
  • Lancer les commandes suivantes :

gui.exe install


core.exe install