Como configurar a integração do Etherpad no BigBlueButton

A integração do Etherpad no BigBlueButton é configurada através do componente de notas compartilhadas do servidor. No BigBlueButton 4.0 beta.4, o Etherpad é opcional: instale os bbb-padspacotes bbb-etherpade selecione o Etherpad para uma reunião específica ou defina-o como padrão para todo o servidor. Em instalações anteriores, onde os pacotes do Etherpad já estão presentes, a principal tarefa é escolher o editor e reiniciar os serviços afetados.

Primeiro, confirme a versão do BigBlueButton que você está usando. A documentação atual da versão 4.0 descreve uma mudança em relação à configuração padrão anterior: o BlockNote é o editor de notas compartilhadas padrão, enquanto os pacotes Etherpad são opcionais. Portanto, selecionar explicitamente o Etherpad evita depender de uma configuração padrão específica da versão. Consulte as notas oficiais sobre os novos recursos do BigBlueButton 4.0 e a referência da API do BigBlueButton .

O que a integração faz

O BigBlueButton apresenta notas compartilhadas dentro de uma reunião e coordena o acesso ao bloco de notas. O Etherpad fornece o editor colaborativo em tempo real usado nessa área. Em uma instalação padrão, os componentes do Etherpad do BigBlueButton são instalados no mesmo servidor; normalmente, não é necessário adicionar um URL público do Etherpad separado nem colar uma chave de API do Etherpad na interface da reunião.

Este guia aborda a configuração do servidor pré-configurado e as opções suportadas para reuniões e para todo o servidor. Uma implementação em cluster ou proxy reverso requer configuração adicional de URL e origem; suas configurações não substituem a instalação e ativação dos componentes do Etherpad.

1. Verifique sua versão do BigBlueButton e os pacotes instalados.

Execute estes comandos no host BigBlueButton:

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

A lista de pacotes ajuda a distinguir uma instalação ausente do Etherpad de um problema de seleção. Em um sistema BigBlueButton 4.0 beta.4, as notas oficiais identificam bbb-shared-notes-servero (BlockNote) como o pacote padrão obrigatório e o pacote bbb-etherpadplus bbb-padscomo opcional. Versões anteriores podem apresentar uma combinação de pacotes diferente, portanto, utilize a documentação da versão realmente instalada em vez de copiar as instruções da versão 4.0 para um servidor mais antigo.

2. Instale os pacotes Etherpad quando necessário.

Na versão beta 4.0 do BigBlueButton, instale os pacotes opcionais com o APT:

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

Analise as alterações propostas pelo gerenciador de pacotes antes de confirmar. Se o APT não encontrar nenhum dos pacotes, verifique se o repositório do BigBlueButton está configurado para a mesma versão do servidor. Não baixe um pacote criado para uma versão diferente do BigBlueButton apenas para que a instalação prossiga.

Após a instalação, confirme se ambos os pacotes aparecem na lista de pacotes. Se estiver atualizando um servidor de produção existente, siga o procedimento oficial de atualização da versão e agende uma janela de manutenção; a instalação de pacotes opcionais é uma alteração do servidor, não uma configuração do cliente de reunião.

3. Ative o Etherpad para uma reunião.

Para usar o Etherpad em uma sessão específica, mantendo as configurações padrão do servidor inalteradas, defina o sharedNotesEditorparâmetro na chamada da API etherpadBigBlueButton dessa reunião :create

sharedNotesEditor=etherpad

O parâmetro pertence à integração do lado do servidor que cria a reunião. O aplicativo deve incluí-lo na solicitação de criação assinada antes de calcular o checksum da API. A API do BigBlueButton aceita `true` etherpadou `false` blockNotepara esta opção. Consulte a documentação da API para verificar o comportamento da sua versão instalada, pois a validação e os valores padrão podem variar de acordo com a versão.

Mantenha o segredo compartilhado do BigBlueButton no servidor. Não o exponha no JavaScript do navegador, no código-fonte da página ou em um cliente móvel. Qualquer pessoa que obtiver o segredo poderá criar chamadas de API assinadas em nome do seu servidor. Se você usa o Greenlight ou outra interface de reunião, configure o parâmetro por meio das configurações compatíveis com essa integração, em vez de editar o URL da reunião no navegador.

4. Defina o Etherpad como o padrão em todo o servidor.

Se todas as reuniões devem usar o Etherpad, edite o arquivo de configuração web do BigBlueButton:

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

Adicione esta linha, preservando as demais configurações do arquivo:

sharedNotesEditor=etherpad

Salve o arquivo e reinicie o BigBlueButton:

sudo bbb-conf --restart

Essa configuração se aplica a reuniões que não fornecem seu próprio sharedNotesEditorvalor. Um parâmetro de criação em nível de reunião pode tornar a escolha explícita para uma sessão específica. As notas oficiais da versão 4.0 documentam essa mesma propriedade para selecionar o Etherpad globalmente e especificam a reinicialização com bbb-conf --restart.

5. Teste o resultado em uma nova reunião.

Após reiniciar, crie uma nova reunião de teste; uma sala já em execução pode não refletir as configurações padrão alteradas. Entre como moderador e como segundo participante, abra as Notas Compartilhadas e confirme se ambos os usuários conseguem visualizar e editar o mesmo bloco de notas. Faça uma breve edição de teste em cada conta, aguarde a atualização da visualização do outro participante e verifique o resultado após fechar e reabrir o painel de notas.

Se você estiver testando uma reunião criada por meio de uma integração de API, inspecione a solicitação de criação dessa integração e confirme se ela incluiu o parâmetro `--reuniion- sharedNotesEditor=etherpadname`. Para um teste com as configurações padrão globais, crie uma reunião sem definir o parâmetro. Isso permite diferenciar uma opção ausente no nível da reunião de um problema de configuração em todo o servidor.

Implantações de proxy de cluster e URLs externas

Quando os navegadores acessam o BigBlueButton por meio de um proxy de cluster ou um nome de host público diferente, os URLs de notas compartilhadas e as origens dos navegadores devem corresponder ao design do proxy. O guia oficial de proxy de cluster do BigBlueButton documenta a pads.urlconfiguração em ` /etc/bigbluebutton/bbb-html5.yml<caminho_do_arquivo>` e uma lista de permissões de proxy de cluster em `<caminho_do_arquivo>`. /etc/bigbluebutton/etherpad.jsonSeu URL de exemplo usa um /padcaminho no host do proxy público. Siga esse guia na íntegra para a configuração do cluster, incluindo seus requisitos de origem e proxy; não copie apenas a linha do URL para uma instalação de servidor único não relacionada.

Após alterar a configuração do cluster, siga os passos de reinicialização e verificação para a versão do BigBlueButton instalada. Se o Etherpad carregar diretamente no hostname do servidor, mas falhar ao passar pelo proxy, investigue a rota do proxy, o hostname, o certificado TLS e a política de origem do navegador antes de alterar a seleção do editor. Um proxy reverso também deve suportar as conexões necessárias para a interface de edição ao vivo do Etherpad.

Solução de problemas em falhas comuns

• O Shared Notes abre no BlockNote. Confirme se a reunião usou o padrão global sharedNotesEditor=etherpadou se ele sharedNotesEditor=etherpadestá presente nele . Na versão 4.0 beta.4, verifique se os dois pacotes opcionais estão instalados./etc/bigbluebutton/bbb-web.properties
• O painel de notas está ausente ou não carrega. Execute o comando sudo bbb-conf --check, verifique o estado do pacote e inspecione os logs de serviço do BigBlueButton e do Etherpad em busca de erros de inicialização ou conexão. Confirme se o navegador está usando o nome de host correto e a origem HTTPS segura.
• Um participante pode editar, mas outro não. Teste com uma nova reunião e contas de navegadores diferentes. Verifique se ambos os usuários entraram na mesma reunião e se nenhum proxy ou camada de autenticação está bloqueando a sessão do Etherpad ou o tráfego WebSocket.
• As alterações não aparecem após edições na configuração. Crie uma nova reunião após a reinicialização. Verifique também se o criador da reunião está passando um valor de editor explícito que substitui o padrão do servidor.
• Funciona diretamente, mas falha ao usar um proxy. Compare o URL das notas públicas, a rota do proxy, a configuração TLS, as origens permitidas e a configuração do cluster com o guia oficial de cluster-proxy. Evite regras de proxy muito amplas que exponham serviços internos não relacionados.

Verificações operacionais e de segurança

Mantenha os pacotes BigBlueButton e Etherpad, bem como o sistema operacional, em caminhos de atualização suportados. Restrinja os segredos da API administrativa a código confiável no servidor, use HTTPS para os endpoints públicos de reuniões e anotações e exponha apenas as rotas necessárias para sua implementação. Se o seu serviço grava reuniões, teste como as anotações compartilhadas são tratadas nas gravações e após o término das reuniões; o comportamento da gravação pode depender da versão do BigBlueButton e da configuração de gravação.

A configuração é concluída quando uma nova reunião seleciona o editor desejado, vários participantes podem colaborar, o console do navegador e os logs do servidor não mostram falhas de conexão e o resultado permanece consistente após reabrir o painel de notas. Para uma implantação da versão 4.0 beta.4, a principal alteração é que o Etherpad deve ser instalado como um componente opcional e selecionado explicitamente. Para outras versões, verifique o comportamento do pacote e da API em relação à documentação da versão antes de alterar um servidor de produção.