Jak skonfigurować integrację Etherpad w BigBlueButton

Integracja Etherpad w BigBlueButton jest konfigurowana za pomocą komponentu Shared Notes na serwerze. W BigBlueButton 4.0 beta.4, Etherpad jest opcjonalny: zainstaluj pakiety bbb-padsi bbb-etherpad, a następnie wybierz Etherpad dla jednego spotkania lub ustaw go jako domyślny dla całego serwera. We wcześniejszych instalacjach, w których pakiety Etherpad są już obecne, głównym zadaniem jest wybranie edytora i ponowne uruchomienie odpowiednich usług.

Najpierw potwierdź swoją wersję BigBlueButton. Aktualna dokumentacja 4.0 opisuje zmianę w stosunku do wcześniejszej domyślnej: BlockNote jest domyślnym edytorem współdzielonych notatek, a pakiety Etherpad są opcjonalne. Dlatego jawne wybranie Etherpad pozwala uniknąć polegania na domyślnym ustawieniu dla konkretnej wersji. Zobacz oficjalne notatki dotyczące nowych funkcji BigBlueButton 4.0 oraz dokumentację API BigBlueButton .

Co robi integracja

BigBlueButton prezentuje udostępnione notatki w trakcie spotkania i koordynuje dostęp do notatnika. Etherpad zapewnia edytor do współpracy na żywo używany w tym obszarze. W standardowej instalacji pakietowej komponenty Etherpad BigBlueButton są instalowane na tym samym serwerze; zazwyczaj nie dodaje się osobnego publicznego adresu URL Etherpad ani nie wkleja klucza API Etherpad do interfejsu spotkania.

W tym przewodniku omówiono konfigurację serwera pakietowego oraz obsługiwane opcje na poziomie spotkań i całego serwera. Wdrożenie klastra lub odwrotnego serwera proxy wymaga dodatkowej konfiguracji adresu URL i źródła; te ustawienia nie zastępują instalacji i włączania komponentów Etherpad.

1. Sprawdź wersję BigBlueButton i zainstalowane pakiety

Uruchom te polecenia na hoście BigBlueButton:

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

Lista pakietów pomaga odróżnić brak instalacji Etherpad od problemu z wyborem. W systemie BigBlueButton 4.0 beta.4, oficjalne informacje identyfikują bbb-shared-notes-server(BlockNote) jako wymagany pakiet domyślny, a bbb-etherpadplus bbb-padsjako pakiet opcjonalny. Wcześniejsze wersje mogą wyświetlać inny zestaw pakietów, dlatego należy korzystać z dokumentacji dla faktycznie zainstalowanej wersji, zamiast kopiować instrukcje dotyczące wersji 4.0 na starszy serwer.

2. Zainstaluj pakiety Etherpad, jeśli to konieczne

W systemie BigBlueButton 4.0 beta.4 zainstaluj opcjonalne pakiety za pomocą APT:

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

Przed potwierdzeniem zapoznaj się z proponowanymi zmianami w menedżerze pakietów. Jeśli APT nie może znaleźć żadnego z pakietów, sprawdź, czy repozytorium BigBlueButton jest skonfigurowane dla tej samej wersji co serwer. Nie pobieraj pakietu skompilowanego dla innej wersji BigBlueButton tylko po to, aby kontynuować instalację.

Po instalacji sprawdź, czy oba pakiety znajdują się na liście pakietów. Jeśli aktualizujesz istniejący serwer produkcyjny, postępuj zgodnie z oficjalną procedurą aktualizacji dla danej wersji i zaplanuj okno konserwacyjne. Instalacja opcjonalnych pakietów jest zmianą serwera, a nie ustawieniem klienta.

3. Włącz Etherpad na jedno spotkanie

Aby używać Etherpad w określonej sesji, pozostawiając domyślne ustawienia serwera bez zmian, należy ustawić sharedNotesEditorparametr na wywołanie API etherpadBigBlueButton danego spotkania :create

sharedNotesEditor=etherpad

Parametr należy do integracji po stronie serwera, która tworzy spotkanie. Aplikacja musi uwzględnić go w podpisanym żądaniu utworzenia przed obliczeniem sumy kontrolnej API. API BigBlueButton akceptuje opcję etherpad„lub” blockNotedla tej opcji. Sprawdź dokumentację API, aby dowiedzieć się, jak działa zainstalowana wersja, ponieważ walidacja i ustawienia domyślne mogą się różnić w zależności od wersji.

Zachowaj współdzielony klucz tajny BigBlueButton na serwerze. Nie ujawniaj go w JavaScript przeglądarki, kodzie źródłowym strony ani kliencie mobilnym. Każdy, kto uzyska klucz tajny, będzie mógł tworzyć podpisane wywołania API jako Twój serwer. Jeśli korzystasz z Greenlight lub innego interfejsu użytkownika do spotkań, skonfiguruj parametr za pomocą obsługiwanych ustawień tej integracji, zamiast edytować adres URL spotkania w przeglądarce.

4. Ustaw Etherpad jako domyślną usługę na całym serwerze

Jeżeli każde spotkanie ma odbywać się za pośrednictwem Etherpad, należy edytować plik nadpisywania internetowego BigBlueButton:

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

Dodaj ten wiersz, zachowując inne ustawienia w pliku:

sharedNotesEditor=etherpad

Zapisz plik i uruchom ponownie BigBlueButton:

sudo bbb-conf --restart

To ustawienie dotyczy spotkań, które nie podają własnej sharedNotesEditorwartości. Parametr tworzenia na poziomie spotkania może wyraźnie określić wybór dla konkretnej sesji. Oficjalne notatki do wersji 4.0 dokumentują tę samą właściwość w przypadku globalnego wyboru Etherpad i określają ponowne uruchomienie za pomocą bbb-conf --restart.

5. Przetestuj wynik na nowym spotkaniu

Po ponownym uruchomieniu użyj nowego spotkania testowego; pokój, który już działa, może nie odzwierciedlać zmienionego ustawienia domyślnego. Dołącz jako moderator i drugi uczestnik, otwórz Notatki współdzielone i upewnij się, że obaj użytkownicy widzą i edytują ten sam notatnik. Wykonaj krótką edycję testową z każdego konta, poczekaj na aktualizację widoku drugiego uczestnika i sprawdź wynik po zamknięciu i ponownym otwarciu panelu notatek.

Jeśli testujesz spotkanie utworzone za pomocą integracji API, sprawdź żądanie utworzenia tej integracji i upewnij się, że zostało uwzględnione sharedNotesEditor=etherpad. W przypadku testu globalnego, utwórz spotkanie bez ustawiania parametru. Pozwala to oddzielić brak opcji na poziomie spotkania od problemu z konfiguracją na poziomie serwera.

Wdrożenia serwera proxy klastra i zewnętrznych adresów URL

Gdy przeglądarki łączą się z BigBlueButton przez serwer proxy klastra lub inną publiczną nazwę hosta, udostępnione adresy URL i źródła przeglądarki muszą być zgodne z projektem serwera proxy. Oficjalny podręcznik dotyczący serwera proxy klastra BigBlueButton dokumentuje pads.urlustawienia w dokumencie /etc/bigbluebutton/bbb-html5.ymloraz listę dozwolonych serwerów proxy klastra w dokumencie /etc/bigbluebutton/etherpad.json. Przykładowy adres URL wykorzystuje /padścieżkę na publicznym hoście proxy. Postępuj zgodnie z tym podręcznikiem w celu skonfigurowania klastra, w tym jego źródła i wymagań dotyczących serwera proxy; nie kopiuj tylko wiersza adresu URL do niepowiązanej instalacji na pojedynczym serwerze.

Po zmianie konfiguracji klastra należy wykonać kroki ponownego uruchomienia i weryfikacji dla zainstalowanej wersji BigBlueButton. Jeśli Etherpad ładuje się bezpośrednio na serwerze z nazwą hosta, ale nie działa przez serwer proxy, przed zmianą wyboru edytora należy sprawdzić trasę serwera proxy, nazwę hosta, certyfikat TLS i politykę pochodzenia przeglądarki. Odwrotny serwer proxy musi również obsługiwać połączenia wymagane przez interfejs edycji na żywo w Etherpadzie.

Rozwiązywanie typowych usterek

• Notatki udostępnione otwierają się w BlockNote. Sprawdź, czy używane spotkanie sharedNotesEditor=etherpadlub sharedNotesEditor=etherpadjest obecne w /etc/bigbluebutton/bbb-web.propertiesglobalnym ustawieniu domyślnym. W wersji 4.0 beta.4 sprawdź, czy dwa opcjonalne pakiety są zainstalowane.
• Panel notatek jest niewidoczny lub się nie ładuje. Uruchom sudo bbb-conf --check, sprawdź stan pakietu i sprawdź dzienniki usług BigBlueButton i Etherpad pod kątem błędów uruchamiania lub połączenia. Upewnij się, że przeglądarka używa prawidłowej nazwy hosta i bezpiecznego źródła HTTPS.
• Jeden uczestnik może edytować, a drugi nie. Przetestuj na nowym spotkaniu i kontach z różnych przeglądarek. Sprawdź, czy obaj użytkownicy dołączyli do tego samego spotkania i czy serwer proxy lub warstwa uwierzytelniania nie blokują sesji Etherpad ani ruchu WebSocket.
• Zmiany nie pojawiają się po edycji konfiguracji. Utwórz nowe spotkanie po ponownym uruchomieniu. Sprawdź również, czy twórca spotkania przekazuje jawną wartość edytora, która zastępuje domyślną wartość serwera.
• Działa bezpośrednio, ale zawodzi za pośrednictwem serwera proxy. Porównaj publiczny adres URL, trasę serwera proxy, konfigurację TLS, dozwolone pochodzenie i konfigurację klastra z oficjalnym przewodnikiem dotyczącym klastrów i serwerów proxy. Unikaj ogólnych reguł proxy, które ujawniają niepowiązane usługi wewnętrzne.

Kontrole operacyjne i bezpieczeństwa

Utrzymuj pakiety BigBlueButton, Etherpad i system operacyjny na obsługiwanych ścieżkach aktualizacji. Ograniczaj sekrety administracyjnego interfejsu API do zaufanego kodu po stronie serwera, używaj protokołu HTTPS dla punktów końcowych spotkań publicznych i notatek oraz udostępniaj tylko ścieżki wymagane przez wdrożenie. Jeśli Twoja usługa rejestruje spotkania, przetestuj, jak obsługiwane są udostępnione notatki w nagraniach i po ich zakończeniu; sposób rejestrowania może zależeć od wersji BigBlueButton i konfiguracji nagrywania.

Konfiguracja jest zakończona, gdy nowe spotkanie wybiera odpowiedniego edytora, wielu uczestników może współpracować, konsola przeglądarki i logi serwera nie wykazują błędów połączenia, a wynik pozostaje spójny po ponownym otwarciu panelu notatek. W przypadku wdrożenia 4.0 beta.4 kluczową zmianą jest to, że Etherpad musi być zainstalowany jako komponent opcjonalny i wybrany jawnie. W przypadku innych wersji, przed zmianą serwera produkcyjnego należy zweryfikować działanie pakietu i interfejsu API w dokumentacji danej wersji.