HumHub

Exigences

• ONLYOFFICE Document Server v6.1.0 (version serveur ou cloud) ou version ultérieure

  Vous avez besoin d'une instance ONLYOFFICE Docs pouvant être résolue et connectée par HumHub et tout autre client final. L'instance doit envoyer des données en POST directement vers HumHub.

  Veuillez consulter la documentation officielle pour en savoir plus sur l'installation d'ONLYOFFICE Docs.
• HumHub 1.8 ou version ultérieure
• Connecteur ONLYOFFICE 2.4.0 pour HumHub

Installer le connecteur ONLYOFFICE pour HumHub

Configurer le connecteur ONLYOFFICE pour HumHub

1. Passez à Administration -> Modules -> Installed (Administration -> Modules -> Installé).
2. Recherchez le module Connecteur ONLYOFFICE pour HumHub.
3. Cliquez sur Configurer.
4. Indiquez les paramètres suivants:
   • Hostname (Nom d'hôte) - indiquez l'adresse URL sur laquelle le service d'édition des documents est installé (par défaut, ONLYOFFICE Docs écoute sur le port 80).
     ImportantL'adresse d'ONLYOFFICE Docs doit être accessible sur HumHub et l'adresse de HumHub doit être accessible sur ONLYOFFICE Docs.
   • JWT Secret - indiquez la clé secrète utilisée pour signer les 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é HumHub: 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 HumHub.
5. 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 HumHub.
6. 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 à HumHub depuis le Service d'édition des documents.

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

Comment cela fonctionne

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

1. Lors de ma création d'un nouveau fichier, les options Document, Classeur ou Présentation sont rendues disponibles à l'utilisateur dans le menu Create document (Créer un document).
2. Le navigateur invoque l'exécution d'indexeur dans le contrôleur /controllers/CreateController.php.
3. Ou, lors de l'ouverture d'un fichier existant, les options View document (Aficher document) ou Edit document (Modifier document) seront disponibles selon l'extension.
4. La fenêtre contextuelle s'affichera et le méthode d'indexation du contrôleur /controllers/OpenController.php sera invoqué.
5. L'application prépare un objet JSON ayant 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 - hachage aléatoire MD5 pour informer ONLYOFFICE Docs s'il faut télécharger le document encore une fois;
   • title - le titre de document (nom);
   • id - l'identifiant d'utilisateur;
   • name - le nom d'utilisateur.
6. HumHub prend cet objet pour construire une page à partir d'un modèle views/open/index.php et remplit toutes les valeurs pour que le navigateur du client puisse télécharger l'éditeur.
7. 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.
8. Ensuite, ONLYOFFICE Docs charge le document depuis HumHub et l'utilisateur commence la rédaction.
9. ONLYOFFICE Docs envoie une requête POST vers callbackUrl pour notifier HumHub que l'utilisateur est en cours de rédaction du document.
10. Lorsque tous les utilisateurs et navigateurs clients ont terminé la rédaction, la fenêtre d'édition est fermée.
11. Après 10 secondes d'inactivité, ONLYOFFICE Docs envoie une requête POST vers callbackUrl pour notifier HumHub que tous les clients ont terminé l'édition et ont fermé le document.
12. HumHub télécharge la nouvelle version du document qui remplace la version ancienne.

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

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.