So konfigurieren Sie die Etherpad-Integration in BigBlueButton

Die Etherpad-Integration in BigBlueButton wird über die Serverkomponente „Gemeinsame Notizen“ konfiguriert. In BigBlueButton 4.0 Beta.4 ist Etherpad optional: Installieren Sie die bbb-padsentsprechenden bbb-etherpadPakete und wählen Sie Etherpad anschließend für eine einzelne Besprechung aus oder legen Sie es als serverweiten Standard fest. Bei älteren Installationen, in denen die Etherpad-Pakete bereits vorhanden sind, besteht die Hauptaufgabe darin, den Editor auszuwählen und die betroffenen Dienste neu zu starten.

Prüfen Sie zunächst Ihre BigBlueButton-Version. Die aktuelle Dokumentation zu Version 4.0 beschreibt eine Änderung gegenüber der vorherigen Standardeinstellung: BlockNote ist der Standardeditor für gemeinsame Notizen, während Etherpad-Pakete optional sind. Durch die explizite Auswahl von Etherpad vermeiden Sie daher die Verwendung einer versionsspezifischen Standardeinstellung. Weitere Informationen finden Sie in den offiziellen BigBlueButton 4.0-Funktionshinweisen und der BigBlueButton-API-Referenz .

Was die Integration bewirkt

BigBlueButton visualisiert gemeinsame Notizen innerhalb einer Besprechung und koordiniert den Zugriff auf das Notizfeld. Etherpad stellt den Live-Editor für die Zusammenarbeit in diesem Bereich bereit. Bei einer Standardinstallation sind die Etherpad-Komponenten von BigBlueButton auf demselben Server installiert; normalerweise müssen Sie keine separate öffentliche Etherpad-URL hinzufügen oder einen Etherpad-API-Schlüssel in die Besprechungsoberfläche einfügen.

Diese Anleitung beschreibt die Einrichtung des Serverpakets sowie die unterstützten Optionen auf Meeting- und Serverebene. Für eine Cluster- oder Reverse-Proxy-Bereitstellung sind zusätzliche URL- und Ursprungskonfigurationen erforderlich; deren Einstellungen ersetzen nicht die Installation und Aktivierung der Etherpad-Komponenten.

1. Überprüfen Sie Ihre BigBlueButton-Version und die installierten Pakete.

Führen Sie diese Befehle auf dem BigBlueButton-Host aus:

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

Die Paketliste hilft, eine fehlende Etherpad-Installation von einem Auswahlproblem zu unterscheiden. Auf einem BigBlueButton 4.0 Beta.4-System wird bbb-shared-notes-server(BlockNote) in den offiziellen Hinweisen als erforderliches Standardpaket und bbb-etherpadplus bbb-padsals optionales Paket angegeben. Ältere Versionen können eine andere Paketzusammensetzung aufweisen. Verwenden Sie daher die Dokumentation der tatsächlich installierten Version, anstatt die Anweisungen für Version 4.0 auf einen älteren Server zu übertragen.

2. Installieren Sie Etherpad-Pakete bei Bedarf.

Bei BigBlueButton 4.0 Beta.4 installieren Sie die optionalen Pakete mit APT:

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

Prüfen Sie die vom Paketmanager vorgeschlagenen Änderungen, bevor Sie die Installation bestätigen. Falls APT keines der Pakete findet, überprüfen Sie, ob das BigBlueButton-Repository für dieselbe Version wie der Server konfiguriert ist. Laden Sie kein Paket herunter, das für eine andere BigBlueButton-Version erstellt wurde, nur um die Installation zu ermöglichen.

Prüfen Sie nach der Installation, ob beide Pakete in der Paketliste angezeigt werden. Wenn Sie einen bestehenden Produktionsserver aktualisieren, befolgen Sie die offizielle Aktualisierungsprozedur der jeweiligen Version und planen Sie ein Wartungsfenster ein. Die Installation optionaler Pakete ist eine Serveränderung und keine Einstellung des Meeting-Clients.

3. Etherpad für ein Meeting aktivieren

Um Etherpad in einer bestimmten Sitzung zu verwenden, während die Standardeinstellungen des Servers unverändert bleiben, setzen Sie den sharedNotesEditorParameter etherpadbeim BigBlueButton-API-Aufruf dieser Sitzung auf create:

sharedNotesEditor=etherpad

Dieser Parameter gehört zur serverseitigen Integration, die das Meeting erstellt. Die Anwendung muss ihn in die signierte Erstellungsanfrage einfügen, bevor die API-Prüfsumme berechnet wird. Die BigBlueButton-API akzeptiert für diese Option die Werte `true` etherpadoder blockNote`false`. Informationen zum Verhalten Ihrer installierten Version finden Sie in der API-Dokumentation, da Validierung und Standardwerte versionsabhängig sein können.

Bewahren Sie das BigBlueButton-Schlüsselwort auf dem Server auf. Geben Sie es nicht im Browser-JavaScript, im Seitenquelltext oder in mobilen Clients preis. Jeder, der das Schlüsselwort erhält, kann signierte API-Aufrufe als Ihr Server durchführen. Wenn Sie Greenlight oder eine andere Meeting-Oberfläche verwenden, konfigurieren Sie den Parameter über die unterstützten Einstellungen dieser Integration, anstatt die Meeting-URL im Browser zu bearbeiten.

4. Etherpad als serverweiten Standard festlegen

Wenn für jedes Meeting Etherpad verwendet werden soll, bearbeiten Sie die BigBlueButton-Web-Override-Datei:

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

Fügen Sie diese Zeile hinzu, wobei die anderen Einstellungen in der Datei beibehalten werden:

sharedNotesEditor=etherpad

Datei speichern und BigBlueButton neu starten:

sudo bbb-conf --restart

Diese Einstellung gilt für Meetings, die keinen eigenen sharedNotesEditorWert liefern. Ein Parameter auf Meeting-Ebene kann die Auswahl für eine bestimmte Sitzung explizit festlegen. Die offiziellen Versionshinweise 4.0 beschreiben dieselbe Eigenschaft für die globale Auswahl von Etherpad und geben den Neustart mit an bbb-conf --restart.

5. Testen Sie das Ergebnis in einem neuen Meeting.

Erstellen Sie nach dem Neustart ein neues Testmeeting; in einem bereits laufenden Meeting werden geänderte Standardeinstellungen möglicherweise nicht angezeigt. Melden Sie sich als Moderator und als zweiter Teilnehmer an, öffnen Sie die gemeinsamen Notizen und vergewissern Sie sich, dass beide Benutzer denselben Notizblock sehen und bearbeiten können. Nehmen Sie von jedem Konto aus eine kurze Testbearbeitung vor, warten Sie, bis die Ansicht des anderen Teilnehmers aktualisiert wurde, und überprüfen Sie das Ergebnis, nachdem Sie das Notizenfenster geschlossen und wieder geöffnet haben.

Wenn Sie ein Meeting testen, das über eine API-Integration erstellt wurde, prüfen Sie die Erstellungsanfrage dieser Integration und stellen Sie sicher, dass der Parameter enthalten ist sharedNotesEditor=etherpad. Um einen globalen Standardtest durchzuführen, erstellen Sie ein Meeting, ohne den Parameter festzulegen. Dadurch lässt sich feststellen, ob eine Option auf Meeting-Ebene fehlt oder ob ein serverweites Konfigurationsproblem vorliegt.

Cluster-Proxy- und externe URL-Bereitstellungen

Wenn Browser über einen Cluster-Proxy oder einen anderen öffentlichen Hostnamen auf BigBlueButton zugreifen, müssen die URLs für die freigegebenen Notizen und die Browserursprünge mit der Proxy-Konfiguration übereinstimmen. Die offizielle Anleitung von BigBlueButton für Cluster-Proxys beschreibt die pads.urlentsprechenden Einstellungen /etc/bigbluebutton/bbb-html5.ymlund eine Cluster-Proxy-Zulassungsliste /etc/bigbluebutton/etherpad.json. Die Beispiel-URL verwendet einen /padPfad auf dem öffentlichen Proxy-Host. Befolgen Sie die gesamte Anleitung für die Cluster-Einrichtung, einschließlich der Anforderungen an Ursprung und Proxy. Kopieren Sie nicht nur die URL-Zeile in eine separate Einzelserverinstallation.

Nach einer Änderung der Clusterkonfiguration führen Sie die Neustart- und Überprüfungsschritte für die installierte BigBlueButton-Version durch. Falls Etherpad direkt über den Hostnamen des Servers geladen wird, aber über den Proxy nicht funktioniert, überprüfen Sie die Proxy-Route, den Hostnamen, das TLS-Zertifikat und die Browser-Ursprungsrichtlinie, bevor Sie die Editorauswahl ändern. Ein Reverse-Proxy muss zudem die für die Live-Bearbeitungsoberfläche von Etherpad erforderlichen Verbindungen unterstützen.

Behebung häufiger Fehler

• Gemeinsame Notizen werden in BlockNote geöffnet. Stellen Sie sicher, dass die verwendete Besprechungsdatei sharedNotesEditor=etherpadoder die entsprechende globale Standardeinstellung sharedNotesEditor=etherpadvorhanden ist . Überprüfen Sie in Version 4.0 Beta.4, ob die beiden optionalen Pakete installiert sind./etc/bigbluebutton/bbb-web.properties
• Das Notizfeld fehlt oder wird nicht geladen. Führen Sie den Befehl aus sudo bbb-conf --check, überprüfen Sie den Paketstatus und prüfen Sie die Dienstprotokolle von BigBlueButton und Etherpad auf Start- oder Verbindungsfehler. Stellen Sie sicher, dass der Browser den korrekten Hostnamen und eine sichere HTTPS-Verbindung verwendet.
• Ein Teilnehmer kann bearbeiten, der andere jedoch nicht. Testen Sie dies mit einem neuen Meeting und Accounts von verschiedenen Browsern. Stellen Sie sicher, dass beide Nutzer demselben Meeting beigetreten sind und dass kein Proxy oder keine Authentifizierungsebene die Etherpad-Sitzung oder den WebSocket-Verkehr blockiert.
• Änderungen werden nach Konfigurationsbearbeitungen nicht angezeigt. Erstellen Sie nach dem Neustart ein neues Meeting. Prüfen Sie außerdem, ob der Meeting-Ersteller einen expliziten Editorwert übergibt, der den Serverstandardwert überschreibt.
• Es funktioniert direkt, aber nicht hinter einem Proxy. Vergleichen Sie die öffentliche Hinweis-URL, die Proxy-Route, die TLS-Konfiguration, die zulässigen Ursprünge und die Clusterkonfiguration mit der offiziellen Cluster-Proxy-Anleitung. Vermeiden Sie weit gefasste Proxy-Regeln, die nicht zugehörige interne Dienste offenlegen.

Betriebs- und Sicherheitsprüfungen

Halten Sie BigBlueButton, Etherpad-Pakete und das Betriebssystem auf unterstützten Updatepfaden. Beschränken Sie administrative API-Geheimnisse auf vertrauenswürdigen serverseitigen Code, verwenden Sie HTTPS für die öffentlichen Endpunkte für Meetings und Notizen und stellen Sie nur die für Ihre Bereitstellung erforderlichen Routen bereit. Wenn Ihr Dienst Meetings aufzeichnet, testen Sie, wie geteilte Notizen in Aufzeichnungen und nach Meetingende verarbeitet werden; das Aufzeichnungsverhalten kann von der BigBlueButton-Version und der Aufzeichnungskonfiguration abhängen.

Die Konfiguration ist abgeschlossen, wenn in einer neuen Besprechung der gewünschte Editor ausgewählt wird, mehrere Teilnehmer zusammenarbeiten können, Browserkonsole und Serverprotokolle keine Verbindungsfehler anzeigen und das Ergebnis nach erneutem Öffnen des Notizbereichs konsistent bleibt. Bei einer Bereitstellung von Version 4.0 Beta.4 besteht die wichtigste Änderung darin, dass Etherpad als optionale Komponente installiert und explizit ausgewählt werden muss. Bei anderen Versionen überprüfen Sie bitte das Paket- und API-Verhalten anhand der Dokumentation der jeweiligen Version, bevor Sie Änderungen an einem Produktivserver vornehmen.