如何在 BigBlueButton 中配置 Etherpad 集成

BigBlueButton 中的 Etherpad 整合是透過伺服器的共享筆記元件進行設定的。在 BigBlueButton 4.0 beta.4 版本中，Etherpad 是可選的：安裝 Etherpadbbb-pads和 Etherpadbbb-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. 為一次會議啟用 Etherpad

若要在特定會話中使用 Etherpad 而保持伺服器預設設定不變，請在會議的 BigBlueButton API 呼叫中設定此sharedNotesEditor參數：etherpadcreate

sharedNotesEditor=etherpad

此參數屬於創建會議的伺服器端整合。應用程式必須先將其包含在已簽署的建立請求中，然後才能計算 API 校驗和。 BigBlueButton 的 API 接受etherpad此blockNote選項。請查看 API 文檔，以了解您已安裝版本的特定行為，因為不同版本的驗證方式和預設值可能有所不同。

請將 BigBlueButton 共享金鑰保存在伺服器端。切勿將其暴露在瀏覽器 JavaScript、頁面原始碼或行動用戶端中。任何獲取此金鑰的人都可以冒充您的伺服器建立簽名 API 呼叫。如果您使用 Greenlight 或其他會議前端，請透過此整合支援的設定配置參數，而不是在瀏覽器中編輯會議 URL。

4. 將 Etherpad 設定為伺服器預設設定

如果每次會議都要使用 Etherpad，請編輯 BigBlueButton 網頁覆蓋檔案：

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

新增以下行，同時保留文件中的其他設定：

sharedNotesEditor=etherpad

保存文件並重啟 BigBlueButton：

sudo bbb-conf --restart

此設定適用於不提供自身sharedNotesEditor價值的會議。會議層級的建立參數可以明確指定特定會話的選擇。官方 4.0 版本說明中記錄了用於全域選擇 Etherpad 並指定重新啟動的相同屬性bbb-conf --restart。

5. 在一次新的會議中測試結果

重新啟動後請使用新的測試會議；已啟動的會議可能無法反映預設設定的變更。以主持人和另一位參與者的身份加入會議，打開共享筆記，並確認兩位用戶都能看到並編輯同一個筆記。分別使用兩個帳戶進行簡短的測試編輯，等待另一位參與者的視圖更新，然後在關閉並重新開啟筆記面板後驗證結果。

如果您正在測試透過 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 版本中，請驗證兩個選用軟體包是否已安裝。
備註面板缺失或無法載入。請執行指令sudo bbb-conf --check，檢查軟體包狀態，並查看 BigBlueButton 和 Etherpad 服務日誌，確認是否有啟動或連線錯誤。確認瀏覽器使用的是預期的主機名稱和安全性的 HTTPS 來源。
一位與會者可以編輯，而另一位則不能。請使用新的會議和來自不同瀏覽器的帳戶進行測試。檢查兩位使用者是否加入了同一個會議，以及代理或驗證層是否阻止了 Etherpad 的會話或 WebSocket 通訊。
配置修改後更改未生效。重啟後請建立新會議。另請檢查會議創建者是否傳遞了覆蓋伺服器預設值的明確編輯器值。
它直接運作正常，但通過代理伺服器後會失敗。請將公開的 URL、代理路由、TLS 設定、允許的來源以及叢集配置與官方的叢集代理指南進行比較。避免使用過於寬泛的代理規則，以免暴露無關的內部服務。

運行和安全檢查

請確保 BigBlueButton、Etherpad 軟體包和作業系統都使用支援的更新路徑。將管理 API 金鑰限制在受信任的伺服器端程式碼中，對公共會議和筆記端點使用 HTTPS，並且僅公開部署所需的路由。如果您的服務會錄製會議，請測試錄製過程中以及會議結束後如何處理共享筆記；錄製行為可能取決於 BigBlueButton 版本和錄製配置。

配置完成的條件是：新建會議時選擇目標編輯器，多個參與者可以協作，瀏覽器控制台和伺服器日誌均未顯示連線故障，且重新開啟備註面板後結果保持一致。對於 4.0 beta.4 版本，關鍵變更在於 Etherpad 必須安裝為選用元件並明確選擇。對於其他版本，在變更生產伺服器之前，請先根據該版本的文件驗證軟體包和 API 的行為。