Comment configurer l'intégration Etherpad dans BigBlueButton

L'intégration d'Etherpad dans BigBlueButton se configure via le composant de notes partagées du serveur. Sur BigBlueButton 4.0 bêta 4, Etherpad est optionnel : installez les paquets bbb-padsnécessaires bbb-etherpad, puis sélectionnez Etherpad pour une réunion ou définissez-le comme éditeur par défaut pour l'ensemble du serveur. Sur les installations antérieures où les paquets Etherpad sont déjà présents, il suffit de choisir l'éditeur et de redémarrer les services concernés.

Commencez par vérifier votre version de BigBlueButton. La documentation actuelle de la version 4.0 décrit un changement par rapport à la version précédente : BlockNote est désormais l’éditeur de notes partagées par défaut, tandis que les paquets Etherpad sont optionnels. Par conséquent, sélectionner explicitement Etherpad vous évite de dépendre d’une valeur par défaut spécifique à une version. Consultez les notes de version officielles de BigBlueButton 4.0 relatives aux nouvelles fonctionnalités et la documentation de l’API BigBlueButton .

Que fait l'intégration ?

BigBlueButton permet d'afficher les notes partagées lors d'une réunion et de gérer l'accès à l'espace de notes. Etherpad fournit l'éditeur collaboratif en temps réel utilisé dans cet espace. Dans une installation standard, les composants Etherpad de BigBlueButton sont installés sur le même serveur ; il n'est généralement pas nécessaire d'ajouter une URL Etherpad publique distincte ni de coller une clé API Etherpad dans l'interface de réunion.

Ce guide décrit la configuration du serveur préconfiguré et les options disponibles au niveau des réunions et du serveur. Le déploiement d'un cluster ou d'un proxy inverse nécessite une configuration supplémentaire des URL et de l'origine ; ces paramètres ne remplacent pas l'installation et l'activation des composants Etherpad.

1. Vérifiez votre version de BigBlueButton et les packages installés.

Exécutez ces commandes sur l'hôte BigBlueButton :

sudo bbb-conf --check
dpkg -l | grep -E 'bbb-(etherpad|pads|shared-notes-server)'

La liste des paquets permet de distinguer l'absence d'Etherpad d'un problème de sélection. Sur un système BigBlueButton 4.0 bêta 4, la documentation officielle indique bbb-shared-notes-serverque (BlockNote) est le paquet requis par défaut et bbb-etherpadque bbb-padsd'autres paquets sont optionnels. Les versions antérieures peuvent présenter une liste de paquets différente ; il est donc conseillé de se référer à la documentation de la version installée plutôt que de copier les instructions de la version 4.0 sur un serveur plus ancien.

2. Installez les paquets Etherpad si nécessaire.

Sur BigBlueButton 4.0 bêta 4, installez les paquets optionnels avec APT :

sudo apt update
sudo apt install bbb-pads bbb-etherpad

Avant de confirmer, veuillez examiner les modifications proposées par le gestionnaire de paquets. Si APT ne trouve aucun des deux paquets, vérifiez que le dépôt BigBlueButton est configuré pour la même version que le serveur. Ne téléchargez pas un paquet conçu pour une version différente de BigBlueButton dans le seul but de poursuivre l'installation.

Après l'installation, vérifiez que les deux paquets figurent bien dans la liste des paquets. Si vous mettez à niveau un serveur de production existant, suivez la procédure de mise à niveau officielle de la version et planifiez une fenêtre de maintenance ; l'installation de paquets optionnels constitue une modification du serveur et non un paramètre du client de réunion.

3. Activer Etherpad pour une réunion

Pour utiliser Etherpad dans une session spécifique tout en laissant les paramètres par défaut du serveur inchangés, définissez le sharedNotesEditorparamètre sur etherpadlors de l'appel d'API BigBlueButton de cette réunioncreate :

sharedNotesEditor=etherpad

Ce paramètre doit être intégré au serveur lors de la création de la réunion. L'application doit l'inclure dans la requête de création signée avant de calculer la somme de contrôle de l'API. L'API de BigBlueButton accepte `true` etherpadou `false` blockNotepour cette option. Consultez la documentation de l'API pour connaître le comportement de votre version, car la validation et les valeurs par défaut peuvent varier.

Conservez le secret partagé BigBlueButton sur le serveur. Ne l'exposez pas dans le code JavaScript du navigateur, le code source de la page ni dans une application mobile. Toute personne qui obtient ce secret peut effectuer des appels API signés en se faisant passer pour votre serveur. Si vous utilisez Greenlight ou une autre interface de réunion, configurez le paramètre via les paramètres dédiés de cette intégration plutôt que de modifier l'URL de la réunion dans le navigateur.

4. Définir Etherpad comme périphérique par défaut pour l'ensemble du serveur.

Si chaque réunion doit utiliser Etherpad, modifiez le fichier de remplacement Web BigBlueButton :

sudo nano /etc/bigbluebutton/bbb-web.properties

Ajoutez cette ligne en conservant les autres paramètres du fichier :

sharedNotesEditor=etherpad

Enregistrez le fichier et redémarrez BigBlueButton :

sudo bbb-conf --restart

Ce paramètre s'applique aux réunions qui ne fournissent pas leur propre sharedNotesEditorvaleur. Un paramètre de création au niveau de la réunion permet de préciser ce choix pour une session particulière. Les notes officielles de la version 4.0 documentent cette même propriété pour la sélection globale d'Etherpad et spécifient le redémarrage avec bbb-conf --restart.

5. Tester le résultat lors d'une nouvelle réunion

Après le redémarrage, créez une nouvelle réunion test ; une salle déjà ouverte risque de ne pas refléter les modifications apportées aux paramètres par défaut. Rejoignez la réunion en tant que modérateur et un deuxième participant, ouvrez les Notes partagées et vérifiez que les deux utilisateurs peuvent voir et modifier le même bloc-notes. Effectuez une brève modification test depuis chaque compte, attendez que l'affichage de l'autre participant se mette à jour, puis vérifiez le résultat après avoir fermé et rouvert le panneau des notes.

Si vous testez une réunion créée via une intégration API, examinez la requête de création de cette intégration et vérifiez qu'elle inclut bien le paramètre sharedNotesEditor=etherpad. Pour un test global par défaut, créez une réunion sans définir ce paramètre. Cela permet de distinguer une option manquante au niveau de la réunion d'un problème de configuration au niveau du serveur.

Déploiements de proxy de cluster et d'URL externes

Lorsque les navigateurs accèdent à BigBlueButton via un proxy de cluster ou un autre nom d'hôte public, les URL des notes partagées et l'origine du navigateur doivent correspondre à la configuration du proxy. Le guide officiel de BigBlueButton relatif aux proxys de cluster documente la pads.urlconfiguration /etc/bigbluebutton/bbb-html5.ymlet la liste blanche du proxy de cluster /etc/bigbluebutton/etherpad.json. L'URL d'exemple utilise un /padchemin sur l'hôte du proxy public. Suivez ce guide dans son intégralité pour la configuration du cluster, y compris les exigences concernant l'origine et le proxy ; ne copiez pas uniquement l'URL dans une installation sur un serveur unique non lié.

Après avoir modifié la configuration d'un cluster, suivez les étapes de redémarrage et de vérification correspondant à la version de BigBlueButton installée. Si Etherpad se charge directement sur le serveur, mais pas via le proxy, vérifiez la configuration du proxy (route, nom d'hôte, certificat TLS et politique d'origine du navigateur) avant de modifier l'éditeur. Un proxy inverse doit également prendre en charge les connexions nécessaires à l'interface d'édition en direct d'Etherpad.

Dépannage des pannes courantes

• Les notes partagées s'ouvrent dans BlockNote. Vérifiez que la réunion a utilisé BlockNote sharedNotesEditor=etherpadou que ce dernier sharedNotesEditor=etherpadest présent dans /etc/bigbluebutton/bbb-web.propertiesles paramètres par défaut globaux. Sur la version 4.0 bêta 4, assurez-vous que les deux modules optionnels sont installés.
• Le panneau de notes est absent ou ne se charge pas. Exécutez la commande sudo bbb-conf --check, vérifiez l'état du paquet et consultez les journaux des services BigBlueButton et Etherpad pour détecter d'éventuelles erreurs de démarrage ou de connexion. Assurez-vous que le navigateur utilise le nom d'hôte attendu et une origine HTTPS sécurisée.
• Un participant peut modifier les paramètres, mais pas l'autre. Effectuez un test avec une nouvelle réunion et des comptes ouverts depuis des navigateurs différents. Assurez-vous que les deux utilisateurs ont rejoint la même réunion et qu'aucun proxy ni système d'authentification ne bloque la session Etherpad ou le trafic WebSocket.
• Les modifications ne sont pas visibles après les changements de configuration. Créez une nouvelle réunion après le redémarrage. Vérifiez également si l'organisateur de la réunion transmet une valeur d'éditeur explicite qui remplace la valeur par défaut du serveur.
• Cela fonctionne directement, mais échoue derrière un proxy. Comparez l'URL des notes publiques, la route du proxy, la configuration TLS, l'origine autorisée et la configuration du cluster avec le guide officiel cluster-proxy. Évitez les règles de proxy trop générales qui exposent des services internes non liés.

Contrôles opérationnels et de sécurité

Assurez-vous que BigBlueButton, les packages Etherpad et le système d'exploitation utilisent des systèmes de mise à jour compatibles. Limitez l'accès aux secrets de l'API d'administration au code serveur de confiance, utilisez HTTPS pour les points de terminaison publics des réunions et des notes, et exposez uniquement les routes nécessaires à votre déploiement. Si votre service enregistre les réunions, testez la gestion des notes partagées pendant et après les enregistrements ; le comportement d'enregistrement peut varier selon la version de BigBlueButton et la configuration d'enregistrement.

La configuration est terminée lorsque, lors d'une nouvelle réunion, l'éditeur souhaité est sélectionné, que plusieurs participants peuvent collaborer, que la console du navigateur et les journaux du serveur ne signalent aucune erreur de connexion et que le résultat reste cohérent après la réouverture du panneau de notes. Pour un déploiement de la version bêta 4.0, le principal changement réside dans l'installation d'Etherpad en tant que composant optionnel, qui doit être sélectionné explicitement. Pour les autres versions, veuillez consulter la documentation de la version concernée afin de vérifier le comportement du package et de l'API avant toute modification sur un serveur de production.