Aller au contenu principal
Version: Any 26

Première installation

Prérequis de configuration​

Any utilise des fichiers de configuration externalisés :

  • settings.json : Configuration principale de l'application
  • hazelcast.xml : Configuration du cluster de cache
  • logback.xml : Configuration du logging
  • shiro.ini : Configuration des permissions

Ces fichiers doivent se trouver dans un dossier défini par le paramètre Java any.configurationPath. Seuls settings.json et hazelcast.xml sont obligatoires. Logback.xml et shiro.ini sont intégrés dans la webapp mais peuvent être externalisés.

Configuration Tomcat​

Ajoutez dans le fichier setenv.sh de $TOMCAT_HOME/bin :

export JAVA_OPTS="$JAVA_OPTS -Dany.configurationPath=/path/to/config"

Configuration Hazelcast (Java 17+)​

Hazelcast 5+ nécessite des paramètres supplémentaires :

export JAVA_OPTS="$JAVA_OPTS \
--add-modules java.se \
--add-exports java.base/jdk.internal.ref=ALL-UNNAMED \
--add-opens java.base/java.lang=ALL-UNNAMED \
--add-opens java.base/java.nio=ALL-UNNAMED \
--add-opens java.base/sun.nio.ch=ALL-UNNAMED \
--add-opens java.management/sun.management=ALL-UNNAMED \
--add-opens jdk.management/com.sun.management.internal=ALL-UNNAMED"

Installation de l'application Web​

  1. Déployer : Copiez any.war dans $TOMCAT_HOME/webapps/
  2. Configurer : Modifiez settings.json selon les sections ci-dessous
  3. Redémarrer : Relancez Tomcat pour déployer l'application

Note sur l'accès à Any :

  • Développement/On-premise : <url de any> = http://localhost:8080/any
  • Production AWS : <url de any> = https://<your-domain>/ (servi à la racine)

Génération des mots de passe chiffrés​

Lorsque vous configurez l'authentification pour ElasticSearch, ActiveMQ ou MongoDB, les mots de passe doivent être chiffrés avec le format $decrypt(...).

Pour générer un mot de passe chiffré :

java -jar $TOMCAT_HOME/webapps/any/WEB-INF/lib/provider-X.XX.X_XX.jar \
eu.c6.auth.GetEncryptedPassword -password "your_password"

Remplacez your_password par votre mot de passe en clair. La commande retournera une chaîne chiffrée que vous utiliserez dans la configuration.


Configuration settings.json​

Serveur Elasticsearch​

Configurez la connexion à ElasticSearch :

{
"elastic-search-data": {
"server": {
"clusterid": "Demo",
"version": 9.2,
"rest_url": "http://localhost:9200",
"user": "",
"password": "",
"sniffingNodes": true
}
}
}

Configuration :

  • version : Version d'ElasticSearch utilisée (ex: 8.14, 9.2)
  • rest_url : URL du serveur ElasticSearch
  • sniffingNodes : Détection automatique des nœuds du cluster

Authentification

Si votre serveur ElasticSearch nécessite des identifiants pour y accéder, complétez les champs user et password. Le mot de passe doit être chiffré : Génération des mots de passe chiffrés

{
"elastic-search-data": {
"server": {
"rest_url": "http://elasticsearch.example.com:9200",
"user": "elastic_user",
"password": "$decrypt(AQDxHzN7m2kJ+...)"
}
}
}

Base de données MongoDB (Master Database)​

MongoDB stocke une copie master de toutes les données pour la récupération d'urgence et la reconstruction d'ElasticSearch :

{
"mongodb-data": {
"server": {
"uri": "mongodb://localhost:27017",
"database": "any_master"
}
}
}

Configuration :

  • uri : Connection string MongoDB
  • database : Nom de la base de données (créée automatiquement si absent)

Authentification

Si MongoDB demande une authentification, intégrez les identifiants dans l'URI de connexion. Le mot de passe doit être chiffré : Génération des mots de passe chiffrés

{
"mongodb-data": {
"server": {
"uri": "mongodb://user:$decrypt(AQDxHzN7m2kJ+...)@mongodb.example.com:27017/?gssapiServiceName=mongodb",
"database": "any_master"
}
}
}

Messaging Server (ActiveMQ)​

Configurez la connexion au broker de messages :

{
"mdb-messaging": {
"as_stream": false,
"is_default_provider": false,
"jms_server_address": "tcp://localhost:61616",
"persistent": true,
"user": "",
"password": ""
}
}

Configuration :

  • jms_server_address : Remplacez localhost par le nom d'hôte d'ActiveMQ

Les files d'attente dépilées par la messagerie et le nombre de consumers se déclarent dans le champ queues. Voir Files d'attente.

Authentification

Si ActiveMQ demande une authentification, ajoutez les identifiants. Le mot de passe doit être chiffré : Génération des mots de passe chiffrés

{
"mdb-messaging": {
"jms_server_address": "tcp://activemq.example.com:61616",
"user": "admin",
"password": "$decrypt(AQDxHzN7m2kJ+...)"
}
}

Stockage des fichiers​

Définissez les répertoires de stockage :

{
"fslocal-content": {
"local_path": "C:/any/data/content"
},
"fslocal-resource": {
"local_path": "C:/any/data/resources"
}
}

Notes :

  • Les chemins doivent être accessibles en lecture/écriture
  • En production, assurez-vous d'avoir suffisamment d'espace disque
  • Les fichiers doivent être accessibles depuis tous les serveurs Tomcat

Installation du Messaging Server​

Le Messaging Server est une application web autonome (messagingServer.war) responsable du traitement asynchrone et de la communication inter-serveurs. Il dépile les files d'attente sur lesquelles les traitements lourds sont déposés.

Déploiement :

  1. Copiez messagingServer.war dans $TOMCAT_HOME/webapps/
  2. Utilisez le même settings.json que pour l'application principale
  3. Redémarrez Tomcat

Recommandations de production :

  • Déployez sur une instance Tomcat dédiée
  • Allouez au minimum 4 Go de RAM
  • Assurez-vous que le répertoire de stockage (local_path) est le même que sur le serveur Web ou accessible via NFS

Installation du serveur de conversion (optionnel)​

Le serveur de conversion (conversionServer.war) génère des PDF et des vignettes à partir des contenus.

Déploiement :

  1. Copiez conversionServer.war dans $TOMCAT_HOME/webapps/
  2. Aucune configuration requise (utilisez la configuration par défaut), les paramètres Java optionnels sont décrits ci-dessous
  3. Redémarrez Tomcat

Recommandations de production :

  • Déployez sur une instance Tomcat dédiée
  • Ce serveur consomme beaucoup de ressources CPU/mémoire pour la conversion

Rendition PDF des fichiers Autocad​

La génération des formats PDF des fichiers Autocad par le serveur de conversion de format requiert un accès supplémentaire au décodeur JPEG de la JVM :

export CATALINA_OPTS="$CATALINA_OPTS --add-opens java.desktop/com.sun.imageio.plugins.jpeg=ALL-UNNAMED"

Commentaires et suivi des modifications Word​

La conversion en PDF d'un document Word supprime les commentaires et accepte toutes les révisions. Le paramètre Java keepComments conserve les commentaires et les marques de révision dans le PDF produit :

export CATALINA_OPTS="$CATALINA_OPTS -DkeepComments=true"

Installation du serveur de vignettes (optionnel)​

Le serveur de vignettes (thumbnailServer.war) stocke et sert les vignettes générées par le serveur de conversion.

Déploiement :

  1. Copiez thumbnailServer.war dans $TOMCAT_HOME/webapps/
  2. Utilisez un settings.json avec au minimum le chemin local_path configuré
  3. Redémarrez Tomcat

Recommandations de production :

  • Déployez sur la même instance que l'application Web Any
  • Le serveur nécessite au minimum 2 Go de RAM

Configuration du cache Hazelcast​

Hazelcast assure la distribution du cache et des sessions entre plusieurs instances Tomcat, permettant une vraie haute disponibilité avec load-balancing.

Paramètres réseau​

Port par défaut : 5701 (auto-incrémenté pour chaque instance : 5702, 5703...)

Assurez-vous que cette plage est ouverte dans vos pare-feu pour la communication inter-nœuds.

Configuration hazelcast.xml​

Editez le fichier hazelcast.xml dans votre répertoire any.configurationPath :

<?xml version="1.0" encoding="UTF-8"?>
<!-- More informations:
https://github.com/hazelcast/hazelcast/blob/master/hazelcast/src/main/resources/hazelcast-default.xml
-->
<hazelcast xmlns="http://www.hazelcast.com/schema/config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.hazelcast.com/schema/config
http://www.hazelcast.com/schema/config/hazelcast-config-3.12.xsd">

<instance-name>${CONTEXT_NAME}</instance-name>

<group>
<!-- Si vous avez plusieurs environnements Any, changez ce nom pour chacun -->
<name>any_environment_01</name>
</group>

<network>
<port auto-increment="true" port-count="100">5701</port>
<join>
<!-- Multicast pour découverte automatique sur le même réseau -->
<multicast enabled="true"/>
<!-- TCP-IP pour configuration statique (décommentez si multicast impossible) -->
<tcp-ip enabled="false">
<interface>127.0.0.1</interface>
<member-list>
<member>127.0.0.1</member>
<!-- Ajoutez les adresses IP des autres nœuds ici -->
</member-list>
</tcp-ip>
</join>
</network>

</hazelcast>

Points importants :

  • Le nom du groupe <name> doit être unique pour chaque environnement Any
  • Le même fichier doit être utilisé dans tous les répertoires de configuration (any, messagingServer, thumbnailServer, conversionServer)
  • Par défaut, Hazelcast utilise la découverte multicast. Pour les environnements où multicast n'est pas disponible, activez TCP-IP

Installation et activation des objets de configuration​

Une fois Any démarré avec les paramètres corrects, une page d'installation s'affiche au premier accès.

Étapes :

  1. Ouvrez votre navigateur et allez à <url de any>/install
  2. La page valide :
    • La configuration (fichiers settings.json, hazelcast.xml)
    • L'accès aux serveurs (MongoDB, ElasticSearch, ActiveMQ)
    • L'accès au serveur d'activation (https://activation.c6cloud.com)
  3. Cliquez sur Installer pour initialiser les objets de configuration

Activation de la licence​

Any nécessite une licence valide pour fonctionner. Vous avez reçu un Customer ID avec vos fichiers binaires.

Avec accès au serveur d'activation​

Recommandé : Both l'application Web et le Messaging Server doivent avoir accès à https://activation.c6cloud.com

  1. Sur la page d'installation, entrez votre Customer ID
  2. Cliquez sur Activer la licence
  3. La licence sera activée automatiquement et renouvelée périodiquement

Sans accès au serveur d'activation​

Si vos serveurs n'ont pas accès à Internet :

  1. Sur la page d'installation, cliquez sur Générer le code d'activation
  2. Envoyez les données générées à votre gestionnaire de compte
  3. Recevez en retour une clé de licence
  4. Connectez-vous en tant que super-administrateur et allez à <url de any>/admin/license
  5. Collez la clé de licence dans la zone Product Key
  6. Cliquez sur Mettre à jour la licence

La licence doit être renouvelée manuellement avant expiration.


Vérification et dépannage​

Checklist finale :

  • ✓ Tous les fichiers WAR sont déployés dans $TOMCAT_HOME/webapps/
  • ✓ Le répertoire any.configurationPath contient settings.json et hazelcast.xml
  • ✓ Les variables d'environnement JAVA_OPTS sont configurées correctement
  • ✓ MongoDB, ElasticSearch et ActiveMQ sont accessibles
  • ✓ La licence est activée
  • ✓ Tomcat démarre sans erreurs dans les logs

Consultez les fichiers de log dans $TOMCAT_HOME/logs/ pour diagnostiquer tout problème de démarrage.