Chamilo

Exigences

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

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

  Veuillez consulter la documentation officielle pour en savoir plus sur l'installation d'ONLYOFFICE Docs.
• Chamilo v1.11.14 ou version ultérieure

Installer le connecteur ONLYOFFICE pour Chamilo

À partir de la version Chamilo v1.11.16 le connecteur ONLYOFFICE est préinstallé. Pour l'activer, procédez comme suit:

1. Accédez au panneau Administration et sélectionnez Plugins (Modules complémentaires) dans le bloc Portal.
2. Dans la liste des modules complémentaires, sélectionnez ONLYOFFICE et cliquez sur le bouton Enable the selected plugins (Activer les modules complémentaires sélectionnés).

Si votre version Chamilo est antérieure à la version 1.11.16, veuillez suivre ces instructions pour installer le connecteur ONLYOFFICE:

1. Téléchargez le connecteur sur GitHub.
2. Accédez au panneau Administration et sélectionnez Plugins (Modules complémentaires) et cliquez sur le bouton Upload plugin (Télécharger module complémentaire).
3. Téléchargez le fichier onlyoffice.zip . La liste de modules complémentaires s'affiche.
4. Lancez composer install en utilisant le terminal du dossier racine Chamilo.
5. Revenez à la liste des modules complémentaires, sélectionnez le module complémentaires ONLYOFFICE et cliquez Enable (Activer).

Mettre à jour le connecteur ONLYOFFICE pour Chamilo

Pour mettre à jour vers la dernière version, il faut remplacer le module complémentaires préinstalé par défaut par le module complémentaires dernier.

Étape 1: Préparez le dossier contenant la version récente du connecteur.

• Le connecteur est disponible en téléchargement à partir du GitHub et décompresser l'archive:

  cd /tmp && wget https://github.com/ONLYOFFICE/onlyoffice-chamilo/releases/download/vX.X.X/onlyoffice.zip

  Où vX.X.X est la version appropriée du connecteur.

  unzip onlyoffice.zip

• Vous pouvez également recueillir le connecteur:
  1. Obtenez la dernière version du référentiel en exécutant la commande:

     git clone https://github.com/ONLYOFFICE/onlyoffice-chamilo
     cd onlyoffice-chamilo

  2. Obtenez le sous-module:

     git submodule update --init --recursive

  3. Recueillez tous les fichiers:

     mkdir /tmp/onlyoffice-deploy
     mkdir /tmp/onlyoffice-deploy/onlyoffice
     cp -r ./ /tmp/onlyoffice-deploy/onlyoffice
     cd /tmp/onlyoffice-deploy/onlyoffice
     rm -rf ./.git*
     rm -rf */.git*

Étape 2: Supprimez l'ancien dossier de connecteur.

1. Ouvrez le terminal dans le répertoire racine.
2. Supprimez le dossier en utilisant la commande suivante:

   rm -rf /var/www/html/chamilo-x.x.x/plugin/onlyoffice

   Où chamilo-x.x.x est votre version de Chamilo.

Étape 3: Déplacez le dossier contenant le nouvel connecteur dans le répertoire chamilo-x.x.x/plugin/.

1. Ouvrez le terminal dans le répertoire racine.
2. Déplacez le dossier en utilisant la commande suivante:

   cp -r /tmp/onlyoffice-deploy/onlyoffice /var/www/html/chamilo-x.x.x/plugin/

   Où chamilo-x.x.x est votre version de Chamilo.

Configurer le connecteur ONLYOFFICE pour Chamilo

Sur la page Plugins (Modules complémentaires), trouvez ONLYOFFICE et cliquez sur Configure. Vous allez voir la page Settings (Paramètres) où vous pouvez configurer les paramètres suivants:

• Saisissez l'adresse utilisée pour accéder au Service d'édition des documents depuis Chamilo dans le champ Document Editing Service address (Adresse du service d'édition des documents).
  Important L'adresse d'ONLYOFFICE Docs doit être accessible sur Chamilo et l'adresse de Chamilo doit être accessible sur ONLYOFFICE Docs.
• Indiquez la clé secrète utilisée pour signer les données dans le champ Secret Key (Clé secrète).
  À 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é Chamilo: 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 Chamilo.

Comment cela fonctionne

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

1. Pour créer un nouveau fichier, le professeur ouvre le dossier nécessaire et fait un clic sur l'icône Create new ONLYOFFICE (Créer).
2. L'utilisateur est redirigé vers la page de création sur laquelle il faut saisir le nom et le format du fichier (document texte, classeur ou présentation). Le navigateur appèle le méthode /plugin/onlyoffice/create.php. Une copie du fichier vide est ajouté dans le dossier des cours.
3. Pour un fichier existant, l'utilisateur doit sélectionner l'icône Open with ONLYOFFICE (Ouvrir avec ONLYOFFICE).
4. La requête est envoyé vers /plugin/onlyoffice/editor.php?docId="document identificator". Le serveur traite la demande, génère la configuration d'initialisation 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;
   • documentServerUrl - l'adresse URL envoyée par le client à ONLYOFFICE Docs (peut être configuré sur la page des paramètres d'administration);
   • key - ETag à informer ONLYOFFICE Docs s'il faut télécharger le document encore une fois;
5. Le serveur renvoie une page avec le script pour ouvrir l'éditeur.
6. Le navigateur ouvre cette page et charge l'éditeur.
7. Le navigateur envoie la requête vers ONLYOFFICE Docs avec la configuration du document.
8. ONLYOFFICE Docs charge le document et l'utilisateur commence la rédaction.
9. ONLYOFFICE Docs envoie une requête POST vers callbackUrl pour notifier Chamilo que l'utilisateur est en cours de rédaction du document.
10. Une fois la rédaction terminée, les utilisateur ferment la fenêtre de l'éditeur.
11. Après 10 secondes d'inactivité, ONLYOFFICE Docs envoie une requête POST vers callbackUrl pour notifier que la session d'édition s'est terlinée et envoie le lien vers la nouvelle version du document.
12. Chamilo charge la nouvelle version du document et remplace le fichier.

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

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.

Désactiver le connecteur ONLYOFFICE pour Chamilo

Si vous souhaitez désactiver le connecteur ONLYOFFICE:

1. Sur la page Plugins (Modules complémentaires), trouvez ONLYOFFICE et cliquez sur Configure.
2. Cochez No (Non) dans la section Enable (Activer).