BigBlueButtonでEtherpad統合を設定する方法

BigBlueButton における Etherpad の統合は、サーバーの shared-notes コンポーネントを通じて設定します。BigBlueButton 4.0 beta.4 では、Etherpad はオプションです。パッケージをインストールしたbbb-pads後bbb-etherpad、特定の会議で Etherpad を選択するか、サーバー全体のデフォルトとして設定してください。Etherpad パッケージが既にインストールされている以前のバージョンでは、主な作業はエディターを選択して、影響を受けるサービスを再起動することです。

まず、BigBlueButtonのリリースバージョンを確認してください。現在の4.0のドキュメントでは、以前のデフォルト設定からの変更点について説明しています。BlockNoteがデフォルトの共有ノートエディタとなり、Etherpadパッケージはオプションとなっています。そのため、Etherpadを明示的に選択することで、リリース固有のデフォルト設定に依存することを回避できます。詳細は、BigBlueButton 4.0の新機能に関する公式ドキュメントとBigBlueButton APIリファレンスを参照してください。

統合によって何ができるか

BigBlueButtonは、会議内で共有ノートを表示し、ノートパッドへのアクセスを調整します。Etherpadは、その領域で使用されるリアルタイムの共同編集エディタを提供します。標準パッケージインストールでは、BigBlueButtonのEtherpadコンポーネントは同じサーバーにインストールされるため、通常は別途Etherpadの公開URLを追加したり、Etherpad APIキーを会議インターフェースに貼り付けたりする必要はありません。

このガイドでは、パッケージ化されたサーバーのセットアップ方法と、会議レベルおよびサーバー全体でサポートされている設定オプションについて説明します。クラスターまたはリバースプロキシ環境での展開には、追加のURLおよびオリジン設定が必要です。これらの設定は、Etherpadコンポーネントのインストールと有効化の代わりにはなりません。

1. BigBlueButtonのバージョンとインストールされているパッケージを確認してください。

BigBlueButtonホスト上で以下のコマンドを実行してください。

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

パッケージリストは、Etherpadのインストール不足とパッケージ選択の問題を区別するのに役立ちます。BigBlueButton 4.0 beta.4 システムでは、公式ノートでbbb-shared-notes-server(BlockNote) が必須のデフォルトパッケージとして、bbb-etherpadその他がbbb-padsオプションパッケージとして指定されています。以前のリリースではパッケージ構成が異なる場合があるため、4.0 の手順を古いサーバーにコピーするのではなく、実際にインストールされているリリースのドキュメントを参照してください。

2. 必要に応じてEtherpadパッケージをインストールする

BigBlueButton 4.0 beta.4 では、APT を使用してオプションパッケージをインストールします。

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

パッケージマネージャーが提案する変更内容を確認してから確定してください。APTがどちらのパッケージも見つけられない場合は、BigBlueButtonリポジトリがサーバーと同じリリース用に設定されていることを確認してください。インストールを進めるためだけに、異なるBigBlueButtonバージョン用にビルドされたパッケージをダウンロードしないでください。

インストール後、両方のパッケージがパッケージ一覧に表示されていることを確認してください。既存の運用サーバーをアップグレードする場合は、リリースの公式アップグレード手順に従い、メンテナンス期間を設定してください。オプションパッケージのインストールはサーバーの変更であり、ミーティングクライアントの設定ではありません。

3. 1つの会議でEtherpadを有効にする

サーバーのデフォルト設定を変更せずに特定のセッションでEtherpadを使用するには、そのミーティングのBigBlueButton API呼び出しでsharedNotesEditorパラメータを次のように設定します。etherpadcreate

sharedNotesEditor=etherpad

このパラメータは、会議を作成するサーバー側の統合処理に含まれます。アプリケーションは、APIチェックサムを計算する前に、署名付き作成リクエストにこのパラメータを含める必要があります。BigBlueButtonのAPIは、このオプションに対してetherpadまたは を受け入れますblockNote。検証とデフォルト値はバージョンによって異なる場合があるため、インストールされているリリースの動作についてはAPIドキュメントを確認してください。

BigBlueButtonの共有シークレットはサーバー上に保管してください。ブラウザのJavaScript、ページソース、モバイルクライアントなどに公開しないでください。シークレットを入手したユーザーは、サーバーになりすまして署名付きAPI呼び出しを作成できます。Greenlightなどの会議フロントエンドを使用する場合は、ブラウザで会議URLを編集するのではなく、その統合機能でサポートされている設定を通じてパラメータを設定してください。

4. Etherpadをサーバー全体のデフォルトに設定する

すべての会議でEtherpadを使用する場合は、BigBlueButtonのWebオーバーライドファイルを編集してください。

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

ファイル内の他の設定を保持したまま、この行を追加してください。

sharedNotesEditor=etherpad

ファイルを保存してBigBlueButtonを再起動してください。

sudo bbb-conf --restart

この設定は、独自の値を提供しない会議に適用されますsharedNotesEditor。会議レベルの作成パラメーターを使用すると、特定のセッションに対して選択を明示的に指定できます。公式の 4.0 ノートでは、Etherpad をグローバルに選択し、再起動時に指定するための同じプロパティについて説明していますbbb-conf --restart。

5．新たな会議で結果を検証する

再起動後、新しいテストミーティングを使用してください。既に実行中のルームでは、変更されたデフォルト設定が反映されない場合があります。モデレーターと2人目の参加者として参加し、共有ノートを開いて、両方のユーザーが同じパッドを表示および編集できることを確認してください。各アカウントから簡単なテスト編集を行い、もう一方の参加者の表示が更新されるまで待ち、ノートパネルを閉じて再度開いた後に結果を確認してください。

API連携によって作成された会議をテストする場合は、その連携の作成リクエストを調べて、必要なパラメータが含まれていることを確認してくださいsharedNotesEditor=etherpad。グローバルデフォルト設定でのテストの場合は、パラメータを設定せずに会議を作成してください。これにより、会議レベルのオプションが欠落している問題と、サーバー全体の設定の問題を区別できます。

クラスタプロキシと外部URLの展開

ブラウザがクラスタプロキシまたは別のパブリックホスト名経由でBigBlueButtonにアクセスする場合、共有ノートのURLとブラウザのオリジンはプロキシの設定と一致する必要があります。BigBlueButtonの公式クラスタプロキシガイドpads.urlには、設定/etc/bigbluebutton/bbb-html5.ymlとクラスタプロキシの許可リストが記載されています/etc/bigbluebutton/etherpad.json。ガイドのサンプルURL/padでは、パブリックプロキシホスト上のパスを使用しています。クラスタの設定については、オリジンとプロキシの要件を含め、ガイド全体に従ってください。URL行だけを無関係なシングルサーバー環境にコピーしないでください。

クラスタ構成を変更した後は、インストールされているBigBlueButtonのバージョンに応じて、再起動と検証の手順に従ってください。Etherpadがサーバーのホスト名に直接アクセスするとロードされるものの、プロキシ経由ではロードされない場合は、エディタの選択を変更する前に、プロキシのルート、ホスト名、TLS証明書、およびブラウザのオリジンポリシーを確認してください。リバースプロキシは、Etherpadのライブ編集インターフェースに必要な接続もサポートしている必要があります。

よくある故障のトラブルシューティング

• 共有ノートは BlockNote で開きます。会議で が使用されたsharedNotesEditor=etherpadか、または がグローバルデフォルトとしてsharedNotesEditor=etherpadに存在することを確認してください/etc/bigbluebutton/bbb-web.properties。4.0 beta.4 では、2 つのオプションパッケージがインストールされていることを確認してください。
• メモパネルが表示されない、または読み込まれません。を実行しsudo bbb-conf --check、パッケージの状態を確認し、BigBlueButton および Etherpad サービスのログを調べて、起動エラーまたは接続エラーがないか確認してください。ブラウザが意図したホスト名と安全な HTTPS オリジンを使用していることを確認してください。
• 参加者のうち1人は編集できますが、もう1人はできません。新しいミーティングと、別のブラウザから作成したアカウントを使用してテストしてください。両方のユーザーが同じミーティングに参加していること、およびプロキシまたは認証レイヤーがEtherpadのセッションまたはWebSocketトラフィックをブロックしていないことを確認してください。
• 設定変更後も変更内容が反映されない場合は、再起動後に新しい会議を作成してください。また、会議作成者がサーバーのデフォルト値を上書きする明示的なエディター値を渡していないかどうかも確認してください。
• 直接接続すると正常に動作しますが、プロキシ経由では動作しません。公開されているメモのURL、プロキシルート、TLS設定、許可されたオリジン、およびクラスタ構成を、公式のクラスタプロキシガイドと比較してください。無関係な内部サービスを公開するような広範なプロキシルールは避けてください。

運用およびセキュリティチェック

BigBlueButton、Etherpadパッケージ、およびオペレーティングシステムは、サポートされている更新パスに維持してください。管理APIのシークレットは信頼できるサーバーサイドコードのみに限定し、公開会議およびメモのエンドポイントにはHTTPSを使用し、デプロイメントに必要なルートのみを公開してください。サービスで会議を録画する場合は、録画中および会議終了後に共有メモがどのように処理されるかをテストしてください。録画の動作は、BigBlueButtonのリリースと録画構成によって異なる場合があります。

新規ミーティングで意図したエディターが選択され、複数の参加者が共同作業でき、ブラウザのコンソールとサーバーのログに接続エラーが表示されず、ノートパネルを再度開いた後も結果が一貫している場合、設定は完了です。4.0 beta.4 の展開では、Etherpad をオプションコンポーネントとしてインストールし、明示的に選択する必要がある点が重要な変更点です。その他のリリースについては、本番サーバーを変更する前に、パッケージと API の動作を該当リリースのドキュメントと照らし合わせて確認してください。