Plone

Exigences

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

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

  Veuillez consulter la documentation officielle pour en savoir plus sur l'installation d'ONLYOFFICE Docs.
• Python 3.4 ou version ultérieure
• Le module complémentaire d'intégration ONLYOFFICE 3.0.1 ou version ultérieure pour Plone

Installer le module d'intégration ONLYOFFICE pour Plone

Configurer le module d'intégration ONLYOFFICE pour Plone

Pour configurer le module complémentaire:

1. Passez à Site Setup (Configuration du site).
2. Faites défiler la page vers la section Add-ons Configuration (Configuration de modules complémentaires).
3. Appuyez sur le bouton ONLYOFFICE Configuration (Configuration d'ONLYOFFICE.).
4. Dans le champ Document Editing service (Service de modification des documents), indiquez l'adresse URL d'ONLYOFFICE Docs.
   L'adresse d'ONLYOFFICE Docs doit être accessible sur Plone et l'adresse Plone doit être accessible sur ONLYOFFICE Docs.
5. Dans le champ 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é Plone: 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 Plone.
6. Dans le champ Server address for internal requests from Document Editing Service (Adresse du serveur pour les demandes internes du Service de modification des documents), indiquez l'adresse utilisée pour accéder à Plone depuis le Service d'édition des documents.
7. Dans le champ Document Editing Service address for internal requests from the server (Adresse du Service de modification des documents pour les demandes internes du serveur), indiquez l'adresse utilisée pour accéder au Service d'édition des documents à partir du serveur Plone.

Développer le module complémentaire Plone pour ONLYOFFICE

1. Clonez le référentiel et modifiez le répertoire.

   git clone --branch deploy git@github.com:ONLYOFFICE/onlyoffice-plone.git cd onlyoffice-plone

2. Créer virtualenv dans le paquet.
3. Installez les éléments requis utilisant pip.
4. Exécutez buildout:

   virtualenv . ./bin/pip install -r requirements.txt ./bin/buildout

5. Démarrez Plone en avant-plan:

   ./bin/instance fg

Si vous avez une instance Plone opérationnelle, vous pouvez installer le module complémentaires en ajoutant les fichiers du projet au répertoire scr:

1. Dans le répertoire scr, créez le répertoire onlyoffice.plone.
2. Placez vos fichiers du projet que vous avez reçu depuis Git dans le répertoire onlyoffice.plone.
3. Modifiez le fichier buildout.cfg:

   [buildout] ... eggs = onlyoffice.plone develop = src/onlyoffice.plone

4. Redémarrez buildout pour valider les modifications:

   .bin/buildout

5. Pour démarrer ou redémarrer votre instance Plone.

Le fondement du Plone est le serveur d'application Zope et ne se connectera en root. Si vous souhaitez vous connecter en tant qu'utilisateur root, vous devez fournir la directive effective-user. Pour ce faire, ajoutez la ligne effective-user

< username >

Mettre à jour le module complémentaire Plone ONLYOFFICE

1. Lorsque vous avez indiqué la version spécifique du module complémentaire dans le fichier buildout.cfg (soi-disant pinning et et une pratique recommandée), comme onlyoffice.plone = 1.0.0, mettez à jour cette référence pour amener avec la version la plus récente. Si on n'a pas indiqué la version du module complémentaire, la version la plus récente sera téléchargée automatiquement:

   [versions] ... onlyoffice.plone = 1.0.1

2. Exécutez bin/buildout. Attendez que la nouvelle version soit téléchargée et installée.
3. La défiguration et les problèmes d'accessibilité de votre site web peuvent survenir jusqu'à ce que vous passiez à l'étape suivante.
4. Accédez à l'écran Add-on (Module complémentaire) (ajoutez /prefs_install_products_form à l'adresse URL de votre site) et dans la liste Upgrades (Mises à jour), sélectionnez onlyoffice.plone et cliquez sur Upgrade onlyoffice.plone. (Mettre à jour onlyoffice.plone).

Comment cela fonctionne

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

1. L'utilisateur accède au document Plone et sélectionne l'action ONLYOFFICE Edit (Modifier dans ONLYOFFICE).
2. Plone 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 - UUID+Modified Timestamp à informer ONLYOFFICE Docs s'il faut télécharger le document encore une fois.
   • title - le titre de document (nom).
3. Plone construit une page à partir d'un modèle .pt et remplit toutes les valeurs pour que le navigateur du client puisse télécharger l'éditeur.
4. 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.
5. Ensuite, ONLYOFFICE Docs charge le document depuis Plone et l'utilisateur commence l'édition.
6. ONLYOFFICE Docs envoie une requête POST vers callbackUrl pour notifier Plone que l'utilisateur est en cours de rédaction du document.
7. Lorsque tous les utilisateurs et les 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 Plone que tous les clients ont terminé l'édition et ont fermé le document.
9. Plone télécharge la nouvelle version du document qui remplace la version ancienne.

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

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.

Se connecter à la version démo ONLYOFFICE Docs

À partir de la version 3.0.0 du connecteur ONLYOFFICE, il est possible d'essayer les éditeurs ONLYOFFICE en ligne au sein de Plone sans installer ONLYOFFICE Docs.

Pour activer la connexion, activez l'option Connect to demo ONLYOFFICE Document Server (Se connecter à la version démo du serveur ONLYOFFICE Documents) et cliquez sur le bouton Enregistrer.