Contexte et solution apportée

Contexte

Dans le cadre du plan de relance, une solution de classe virtuelle du ministère de l'Enseignement Supérieur et de la Recherche (ESR), s'appuyant sur logiciel libre et open source BigBlueButton (BBB), a été déployée à l'échelle nationale.

Plus d'informations peuvent être retrouvées sur les sites suivants :

• https://doc.numerique-esr.fr/
• https://www.enseignementsup-recherche.gouv.fr/fr/classes-virtuelles-et-webinaires-pour-l-enseignement-superieur-90257

Pour les établissements n'ayant jamais eu d’infrastructure locale BigBlueButton, l'utilisation de cette solution de classe virtuelle (BBB ESR) est simple à mettre en œuvre.

Cependant, pour les établissements ayant auparavant une infrastructure locale BBB, l'utilisation du BBB de l'ESR présente des impacts aux usagers.

Cette documentation peut alors être utile pour ces établissements.

Impacts

Changer d'infrastructure est extrêmement simple, que cela soit pour n'importe quelle plateforme :

• Pod : changer le paramétrage du module des Réunions dans le fichiers custom/settings_local.py, à savoir BBB_API_URL et BBB_SECRET_KEY
  
  
• Moodle (v4) : changer le paramétrage, accessible via le module d'Administration du site, à savoir l'URL du serveur BigBlueButton et le Secret partagé BigBlueButton.
  
  
• Greenlight : changer le paramétrage dans le fichier .env, à savoir BIGBLUEBUTTON_ENDPOINT et BIGBLUEBUTTON_SECRET

En modifiant ces paramètres, la plateforme pointe alors sur la nouvelle architecture BBB.

Pour les usagers, les impacts concernent les enregistrements, qui ne seront alors plus visibles.

En effet, les sessions/réunions sont toujours accessibles aux usagers, car elles sont sauvegardées dans la plateforme concernée, mais pas les enregistrements.

Il faut savoir que ces enregistrements sont sauvegardés directement sur l'infrastructure BBB (soit sur le serveur BBB soit sur le serveur Scalelite).

Dans les plateformes, les liens vers ces enregistrements sont alors affichés au moment de la consultation de la session / réunion.

Au final, lors d'un changement d'infrastructure, les anciens enregistrements ne s'affichent plus aux usagers; et lorsque l'ancienne architecture BBB sera arrêtée, les anciens enregistrements ne seront même plus disponibles, si rien n'a été réalisé avant.

Contraintes

Voici un rappel des contraintes à prendre en compte et qui explique la solution proposée :

• Contrainte vis-à-vis de Pod : nous ne souhaitons plus utiliser l'ancien module BBB de Pod, qui est amené à disparaître rapidement.
  
  
• Contrainte de l'API BBB : les participants et modérateurs ne sont disponibles que lorsque la session BBB est en cours. Une fois arrêtée, l'information n'y est plus dans BBB. Nous n'avons alors ces informations que dans le client BBB, à savoir Pod ou Moodle (ou Greenlight...).
  
  
• Contrainte BBB : par défaut, il est possible de reconstruire un enregistrement BBB (typiquement pour avoir l'enregistrement au format vidéo) que si les fichiers raw sont encore présents. Par défaut, ces fichiers raw sont supprimés au bout de 14 jours. On ne peut alors baser la solution sur la reconstruction des enregistrements.

Solution apportée

L'idée est de se baser sur :

• le système de revendication des enregistrements de Pod (cf. https://www.esup-portail.org/wiki/x/DgB8Lw),
  
  
• le système d'import des vidéos externes pour y ajouter la possibilité de convertir des enregistrements BBB, de type présentation, en vidéo (via le plugin bbb-recorder, cf. ci-dessous),
  
  
• un script de migration, qui offre plusieurs possibilités.

Ce script de migration est configurable et offre plusieurs possibilités, à savoir:

• 1° possibilité, pour ceux qui ont peu d'enregistrements à récupérer

Ce script va convertir les présentations, de l'ancienne architecture BBB, en fichiers vidéo (comme précédemment, via le plugin bbb-recorder) et positionner ces fichiers dans le répertoire pour la Revendication des enregistrements.

Bien sûr, s'il y a déjà des présentations en vidéo, le fichier vidéo sera directement copié.

Une fois que toutes les vidéos ont été encodées, l'architecture BBB locale peut être arrêtée. Les usagers devront aller chercher leurs vidéos dans l'onglet Revendication des enregistrements dans Pod.

• 2° possibilité, pour ceux qui ont beaucoup d'enregistrements à récupérer

L'idée est de laisser le temps aux usagers de choisir par eux-mêmes les enregistrements qu'ils souhaitent conserver (il n'est pas possible et utile de tout convertir).

Pour cela, il faudra laisser l'ancien serveur BBB/Scalelite ouvert au moins pendant quelques mois (juste pour accéder aux enregistrements).

Côté script, si besoin, il faudra un accès à la base de données de Moodle pour savoir qui a réalisé quoi.

Ainsi, pour chaque enregistrement BBB, le script va créer une ligne dans Mes vidéos externes, de type BigBlueButton, pour les modérateurs (qui seront créés si besoin dans la base de Pod).
Ils pourront alors par eux-mêmes importer ces enregistrements dans Pod.
Au cas où, si des enregistrements ne sont pas identifiables, ils seront associés à un administrateur (à paramétrer dans le script).

De plus, si l'accès à la base de Moodle le permet, un message d'information sera positionné directement dans Moodle, au niveau des sessions BBB concernées.

Le script est prévu pour être paramétrable, avec possibilité de gérer un certain nombre d'enregistrements et de pouvoir le tester avant (utilisation d'un mode dry).

Architecture de la solution

Plugin bbb-recorder

Pour convertir les playback présentation de BBB, je me suis basé sur le projet Github bbb-recorder (https://github.com/jibon57/bbb-recorder) : un plugin, indépendant de BigBlueButton, qui permet de convertir - via un script - une présentation Web BigBlueButton en fichier vidéo.

Si besoin, ce plugin permet également une diffusion en direct (flux RTMP) d'un cours BigBlueButton.

Fonctionnement de bbb-recorder

Le fait d'exécuter le script bbb-recorder réalise les étapes suivantes :

• Lance un navigateur Chrome en arrière-plan,
• Chrome visite le lien - correspondant à la présentation Web BigBlueButton - fourni,
• Il effectue l'enregistrement d'écran sous la forme d'un fichier vidéo.

Installation de bbb-recorder sur les serveurs d'encodage

Il est nécessaire d'installer bbb-recorder sur les serveurs d'encodage.

La documentation de référence est accessible ici : https://github.com/jibon57/bbb-recorder

Pour ma part, sur les serveurs Debian 11, voici ce qui a été réalisé.

Installation de bbb-recorder sur Debian 11

Ce plugin n'a pas besoin d'être installé sur un serveur BigBlueButton.

Installation de Chrome et des pré-requis

pod@test:~/$ sudo -i
root@test:~/$ apt install xvfb
root@test:~/$ curl -sS -o - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add
root@test:~/$ echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google-chrome.list
root@test:~/$ apt-get -y update
root@test:~/$ apt-get -y install google-chrome-stable

Étant un serveur d'encodage, je considère que ffmpeg est déjà installé. Si besoin, il est nécessaire d'installer ffmpeg.

Installation effective

Voici l'installation pour un utilisateur pod.

pod@test:~/$ cd ~
pod@test:~/$ git clone https://github.com/jibon57/bbb-recorder
pod@test:~/$ cd bbb-recorder
pod@test:~/bbb-recorder/$ npm install --ignore-scripts
pod@test:~/bbb-recorder/$ cp .env.example .env

Gestion du répertoire contenant les vidéos : dans mon cas /data/www/pod/bbb-recorder et du répertoire de logs /data/www/pod/bbb-recorder/logs.

pod@test:~/bbb-recorder/$ mkdir /data/www/pod/bbb-recorder
pod@test:~/bbb-recorder/$ mkdir /data/www/pod/bbb-recorder/logs

Paramétrage de bbb-recorder

• Édition du fichier de configuration ~/bbb-recorder/.env pour paramétrer le RTMP (inutile ici) et surtout le répertoire des vidéos.
  
  

{
"rtmpUrl": "rtmp://xxxxxxxx:xxxxxxxxxx@xxxxx.univ.fr:1935/live/stream",
"ffmpegServer": "ws://localhost",
"ffmpegServerPort": 4000,
"auth": "xxxx",
"copyToPath": "/data/www/pod/bbb-recorder"
}

• Si besoin, réaliser le paramétrage dans le fichier examples/index.js (pour réaliser un live ou enregistrer en direct une Web conférence) :
  
  

const BBBUrl = "https://xxxx.univ.fr/bigbluebutton/", 
BBBSalt = "xxxxxxxxxxxxxxxxxxxx", 
joinName = "recorder";

• Si vous le souhaitez, vous pouvez configurer le bitrate pour contrôler la qualité de la vidéo exportée en ajustant la propriété videoBitsPerSecond dans background.js.

Paramétrage

Configuration dans Pod

Une fois bbb-recorder installé sur les différents serveurs d'encodage, il reste à configurer le plugin bbb directement dans Pod, via l'édition de fichier custom/settings_local.py (sur les encodeurs et sur le frontal) :

# Use import-video module
USE_IMPORT_VIDEO = True

# Use plugin bbb-recorder for import-video module
# Useful to convert prensentation playback to video file
USE_IMPORT_VIDEO_BBB_RECORDER = True

# Directory of bbb-recorder plugin (see documentation https://github.com/jibon57/bbb-recorder)
# bbb-recorder must be installed in this directory, on all encoding servers
# bbb-recorder create a directory Downloads, at the same level, that needs disk space
IMPORT_VIDEO_BBB_RECORDER_PLUGIN = '/home/pod/bbb-recorder/'

# Directory that will contain the video files generated by bbb-recorder
IMPORT_VIDEO_BBB_RECORDER_PATH = '/data/www/pod/bbb-recorder/'

Les éléments de paramétrage sont les suivants :

• USE_IMPORT_VIDEO : utilisation (True/False) du module d'import des vidéos pour Pod
  
  

• USE_IMPORT_VIDEO_BBB_RECORDER : utilisation (True/False) du plugin bbb-recorder pour le module import-vidéo; utile pour convertir une présentation BigBlueButton en fichier vidéo.
  
  

• IMPORT_VIDEO_BBB_RECORDER_PLUGIN : Répertoire du plugin bbb-recorder (voir la documentation https://github.com/jibon57/bbb-recorder).
  bbb-recorder doit être installé dans ce répertoire, sur tous les serveurs d'encodage.
  bbb-recorder crée un répertoire Downloads, au même niveau, qui nécessite de l'espace disque.
  
  
• IMPORT_VIDEO_BBB_RECORDER_PATH : Répertoire qui contiendra les fichiers vidéo générés par bbb-recorder.

Concernant le répertoire contenant les fichiers vidéos générés par bbb-recorder (IMPORT_VIDEO_BBB_RECORDER_PATH), il est à créer manuellement - en même temps que son sous-répertoire des logs -  avec les lignes de commande suivantes; n'hésitez pas à les modifier à votre convenance selon votre architecture système et vos droits :

pod@test:~/$ mkdir /data/www/pod/bbb-recorder/logs -p
pod@test:~/$ chown pod:nginx /data/www/pod/bbb-recorder/logs

Script migrate_bbb_recordings

Ce script est accessible dans Pod, dans le répertoire pod/video/management/commands/migrate_bbb_recordings.

Fonctionnement du script

Comme évoqué ci-dessus, ce script offre 2 possibilités, à savoir :

• 1° possibilité, pour ceux qui ont peu d'enregistrements à récupérer

Ce script va convertir les présentations, de l'ancienne architecture BBB, en fichiers vidéo (via le plugin bbb-recorder) et positionner ces fichiers dans le répertoire d'un enregistreur pour la Revendication des enregistrements (cf. https://www.esup-portail.org/wiki/x/DgB8Lw)

Bien sûr, s'il y a déjà des présentations en vidéo, le fichier vidéo sera directement copié.

Une fois que toutes les vidéos ont été encodées, l'architecture BBB locale peut être arrêtée. Les usagers devront aller chercher leurs vidéos dans l'onglet Revendication des enregistrements dans Pod.

Ceci est possible en utilisant le paramètre --use-manual-claim et la configuration directement dans ce fichier.

• 2° possibilité, pour ceux qui ont beaucoup d'enregistrements à récupérer

L'idée est de laisser le temps aux usagers de choisir par eux-mêmes les enregistrements qu'ils souhaitent conserver (il n'est pas possible et utile de tout convertir).

Pour cela, il faudra laisser l'ancien serveur BBB/Scalelite ouvert au moins pendant quelques mois (juste pour accéder aux enregistrements).

Côté script, si besoin, il faudra un accès à la base de données de Moodle pour savoir qui a réalisé quoi.

Ainsi, pour chaque enregistrement BBB, le script va créer une ligne dans Mes vidéos externes, de type BigBlueButton, pour les modérateurs (qui seront créés si besoin dans la base de Pod).
Ils pourront alors par eux-mêmes importer ces enregistrements dans Pod. Au cas où, si des enregistrements ne sont pas identifiables (par exemple en provenance d'autres sources que Pod ou Moodle), ils seront associés à un administrateur (à paramétrer dans le script).

De plus, si l'accès à la base de Moodle le permet, un message d'information sera positionné directement dans Moodle, au niveau des sessions BBB concernées.

Ceci est possible en utilisant le paramètre --use-import-video, le paramètre --use-database-moodle (optionnel) et la configuration directement dans ce fichier.

• 3° possibilité, à partir de pod 3.6.0, vous pouvez aussi faire uniquement un export au format CSV de la liste des enregistrements BBB (ce qui vous permet de traiter ensuite ces derniers par ailleurs)
  Ceci est possible en utilisant le paramètre --use-export-csv, le paramètre --use-database-moodle (optionnel) et la configuration directement dans ce fichier.

Ce script vous permet également de :

• simuler ce qui sera fait via le paramètre --dry
  
  
• de ne traiter que certaines lignes via les paramètres --min-value-record-process  et --max-value-record-process.

Paramétrage interne au script

Arguments du script

Exemples et cas d'utilisation

Voici quelques exemples et cas d'utilisation de ce script, à ne lancer qu'après avoir réalisé le paramétrage interne. N'hésitez pas à faire des essais sur quelques lignes et d'utiliser le mode dry pour comprendre ce qui sera réalisé.

•  Utilisation de la revendication pour tous les enregistrements, en simulation uniquement :

  python -W ignore manage.py migrate_bbb_recordings --use-manual-claim --dry

•  Utilisation de la revendication d'enregistrements pour seulement les 2 enregistrements les plus récents, en simulation uniquement :
  

  python -W ignore manage.py migrate_bbb_recordings --min-value-record-process=1 --max-value-record-process=2 --use-manual-claim --dry &

  
  
  

  Utilisation de Celery ou non ?

  Si vous utilisez les tâches asynchrones (CELERY_TO_ENCODE = True), sans le dry, cette commande va lancer 2 tâches d'encodage.

  Si vous n'utilisez pas les tâches asynchrones (CELERY_TO_ENCODE = False), sans le dry, cette commande va réaliser directement l'encodage (sauf si le playback est au format vidéo bien entendu) de la 1° présentation, puis une fois celle-ci terminée, l'encodage de la 2° présentation.
  Dans ce cas là, cela peut être long, d'où l'utilisation en arrière plan (via le & en fin de commande).

  
  
  
• Utilisation du module d'importation vidéo externe, avec accès à la base de données Moodle pour tous les enregistrements, en simulation uniquement :
  

  python -W ignore manage.py migrate_bbb_recordings --use-import-video --use-database-moodle --dry

  
  

  Pas d'encodage réalisé

  Sans le dry, cette commande va créer des lignes d'enregistrements externes dans la base de Pod, pour le module d'import des vidéos. Il n'y a alors aucun encodage qui est réalisé à ce moment.

  Les usagers pourront retrouver ces enregistrements dans ce module d'import des vidéos et les téléverser sur Pod en tant que vidéo : c'est à ce moment que l'encodage sera réalisé.

  
  
  
• Utilisation du module d'importation vidéo externe, sans accès à la base de données Moodle pour les 10 enregistrements les plus récents, en simulation uniquement :
  

  python -W ignore manage.py migrate_bbb_recordings --min-value-record-process=1 --max-value-record-process=10 --use-import-video --dry

• Utilisation du module d'export CSV, avec accès à la base de données Moodle pour les 10 enregistrements les plus récents, en simulation uniquement :
  

  python3 manage.py migrate_bbb_recordings --use_export_csv --use-database-moodle --max-value-record-process=10 --dry

Exploitation

Sortie du script migrate_bbb_recordings

Le script affiche un ensemble d'informations pour chaque ligne traitée; il ne faut pas hésiter à le lancer en mode dry.

Interface d'administration

Revendication des enregistrements,

L'interface d'administration permettant de suivre les enregistrements traités concerne les enregistreurs et les enregistrements.

Un enregistreur :

Liste des enregistrements :

Import des vidéos externes

L'interface d'administration permettant de suivre les enregistrements traités concerne les enregistrements externes dans Importer une vidéo externe.

Logs de la solution

Tâches asynchrones (CELERY_TO_ENCODE = True)

Sur les serveurs d'encodage, les logs celery se trouvent dans /var/log/celery/worker1.log (selon votre configuration, si vous utilisez plusieurs workers, vous pouvez avoir plusieurs fichiers).

RabbitMQ-Server

Si vous utilisez RabbiMQ-Server, sur ce serveur, vous pouvez avoir des informations dans /var/log/rabbitmq/rabbit@xxxxx.log.

bbb-recorder

Les logs des traitements de bbb-recorder sont accessibles dans le répertoire configuré via IMPORT_VIDEO_BBB_RECORDER_PATH/logs.

Suppression des enregistrements externes du module d'import des vidéos

Si vous avez opté pour la 2° possibilité, et l'utilisation du module d'import des vidéos : le jour de l'arrêt complet de votre ancienne infrastructure, les anciens liens ne fonctionneront plus.

Si vous souhaitez supprimer les enregistrements externes qui concernaient votre ancienne infrastructure, il vous est possible de le faire directement via une requête SQL à exécuter dans la base de données de Pod, à savoir :

# Remplacer SCRIPT_BBB_SERVER_URL par la bonne valeur, selon votre environnement
DELETE FROM import_video_externalrecording WHERE source_url like 'SCRIPT_BBB_SERVER_URL%'