Liferay

Compiler le connecteur ONLYOFFICE pour Liferay

Exécutez gradle build. Le fichier résultant .jar sera placé dans le référentiel build/libs directory.

Configurer le connecteur ONLYOFFICE pour Liferay

Passez à Control Panel -> Configuration -> System Settings (Panneau de configuration -> Configuration -> Paramètres du système). Dans la section Platform (Plateforme) sélectionnez la catégorie Connectors (Connecteurs) et ensuite ONLYOFFICE.

Ici vous pouvez configurer les paramètres suivants:

• ONLYOFFICE Docs address (Adresse d'ONLYOFFICE Docs) - indiquez l'adresse URL du Service de modification des documents.
  L'adresse d'ONLYOFFICE Docs doit être accessible sur Liferay et l'adresse de Liferay doit être accessible sur ONLYOFFICE Docs.
• ONLYOFFICE Docs address for internal requests from the server (Adresse d'ONLYOFFICE Docs pour les demandes internes du serveur) - indiquez l'adresse utilisée pour accéder au Service d'édition des documents à partir du serveur Liferay.
• Server address for internal requests from ONLYOFFICE Docs (Adresse du serveur pour les demandes internes d'ONLYOFFICE Docs) - indiquez l'adresse utilisée pour accéder à Liferay depuis le Service d'édition des documents.
• Secret Key (Clé secrète) - indiquez la clé secrète utilisée pour signer des données.
  À partir de la version de ONLYOFFICE Docs v.7.2, JWT est activé par défaut et la clé secrète est générée automatiquement. Il vous faut également activer la validation du jeton du côté Liferay: recherchez votre clé secrète dans le fichier de configuration ONLYOFFICE Docs, ensuite indiquez la même clé secrète dans les paramètres du connecteur. Pour en savoir plus, consultez la section Activer le jeton JWT pour l'intégration ONLYOFFICE et Liferay.
• Enable Force Save (Activer la sauvegarde forcée) - activez cette option pour que les versions intermédiaires du document soient gardées lors de l'édition.
• Enable ONLYOFFICE Web Preview (Activer l'aperçu Web pour ONLYOFFICE) - activer cette option pour afficher l'aperçu du fichier.

Une fois l'application d'intégration configurée, cliquez sur Save (Enregistrer) pour valider les modifications.

Comment cela fonctionne

L'intégration ONLYOFFICE suit l'API disponible ici.

1. L'utilisateur doit passer à la section Documents and Media (Documents et média) dans Liferay et sélectionner l'action Edit in ONLYOFFICE (Modifier dans ONLYOFFICE).
2. Liferay prépare l'objet JSON pour le Serveur de documents avec les caractéristiques suivantes:
   • url - l'adresse URL utilisée par ONLYOFFICE Docs pour télécharger le document;
   • callbackUrl - l'adresse URL utilisée par ONLYOFFICE Docs pour informer sur l'état de l'édition du document;
   • key - fileVersionId à informer ONLYOFFICE Docs s'il faut télécharger le document encore une fois;
   • title - le titre de document (nom).
3. Le navigateur du client envoie une demande vers la bibliothèque JavaScript depuis ONLYOFFICE Docs et la configuration DocEditor vers ONLYOFFICE Docs avec les caractéristiques ci-dessous.
4. Ensuite, ONLYOFFICE Docs charge le document depuis Liferay et l'utilisateur commence la rédaction.
5. ONLYOFFICE Docs envoie une requête POST vers callbackUrl pour notifier Liferay que l'utilisateur est en cours de rédaction du document.
6. Le document est verouillé par Liferay, mais les utilisateurs ayant l'accès en écriture peuvent collaborer en temps réel avec ONLYOFFICE Docs en conservant Action.
7. Lorsque tous les utilisateurs et navigateurs clients ont terminé la rédaction, la fenêtre d'édition est fermée.
8. Après 10 secondes d'inactivité, ONLYOFFICE Docs envoie une requête POST vers callbackUrl pour notifier Liferay que tous les clients ont terminé l'édition et ont fermé le document.
9. Liferay télécharge la nouvelle version du document qui remplace la version ancienne.

Activer le jeton JWT pour l'intégration ONLYOFFICE et Liferay

Afin de protéger des documents contre un accès non autorisé, les éditeurs ONLYOFFICE utilisent le jeton JSON (JWT). Le jeton est ajouté à la configuration lorsque l'éditeur de documents est initialisé et l'échange de commandes entre les services internes de ONLYOFFICE Docs est effectué. La clé secrète est utilisée pour signer le jeton web JSON et valider le jeton sur demande à ONLYOFFICE Docs.

À partir de la version de ONLYOFFICE Docs v.7.2, JWT est activé par défaut et la clé secrète est générée automatiquement. Il vous faut rechercher votre clé secrète dans le fichier de configuration ONLYOFFICE Docs, ensuite indiquez la même clé secrète dans les paramètres du connecteur.

Étape 1: Recherchez votre clé secrète dans le fichier de configuration ONLYOFFICE Docs

1. Ouvrez le fichier local.json avec tout éditeur de texte disponible.
   • Pour Linux - /etc/onlyoffice/documentserver/local.json
   • Pour Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
   • Pour Docker – indiquez le conteneur ONLYOFFICE Docs en utilisant la commande docker exec -it <containerID> bash et ouvrez /etc/onlyoffice/documentserver/local.json

     Vous pouvez également utiliser la commande suivante pour rechercher la clé secrète par défaut et sans ouvrir le fichier local .json:

     sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

   Le fichier local .json doit ressembler à ceci:

   {"services": {"CoAuthoring": {"token": {"enable": {"request": {"inbox": true,"outbox": true},"browser": true}},"secret": {"inbox": {"string": "yoursecret"},"outbox": {"string": "yoursecret"},"session": {"string": "yoursecret"}}}}}

2. Le paramètre true figure dans trois sections. Cela signifie que la validation du jeton est activée.
   • services.CoAuthoring.token.enable.browser
   • services.CoAuthoring.token.enable.request.inbox
   • services.CoAuthoring.token.enable.request.outbox
3. La clé secrète qui a été généré automatiquement figure dans trois sections. Vous pouvez remplacer le secret par défaut par votre propre clé secrète. La clé secrète doit être la même dans toutes trois sections.
   • services.CoAuthoring.secret.inbox.string
   • services.CoAuthoring.secret.outbox.string
   • services.CoAuthoring.secret.session.string
4. Lorsque vous apportez des modifications, il vous faut les enregistrer et redémarrer les services pour prendre en compte ces modifications.

   supervisorctl restart all

Étape 2: Indiquez la même clé secrète dans la configuration du connecteur.

Dans la configuration du connecteur, indiquez la même clé secrète dans le champ Secret key (Clé secrète) et enregistrez les paramètres.