HumHub

Requisitos

• ONLYOFFICE Document Server v6.1.0 (servidor ou versão cloud) ou posterior

  Você precisa de uma instância do ONLYOFFICE Docs que seja resolvível e conectável tanto do HumHub quanto de qualquer cliente final. Deve ser capaz de fazer POST para o HumHub diretamente.

  Consulte a página de documentação oficial para saber mais sobre a instalação do ONLYOFFICE Docs.
• HumHub 1.8 ou posterior
• Conector ONLYOFFICE 2.4.0 para HumHub

Instalando o conector ONLYOFFICE para HumHub

Configurando o conector ONLYOFFICE para HumHub

1. Vá para Administração → Módulos → Instalados.
2. Encontre o módulo ONLYOFFICE Connector for HumHub.
3. Clique no botão Configurar.
4. Especifique os seguintes parâmetros:
   • Hostname - especifique o endereço URL onde o Serviço de Edição de Documentos está instalado (o ONLYOFFICE Docs é instalado na porta 80 por padrão).
     ImportanteO endereço do ONLYOFFICE Docs deve estar acessível do HumHub, assim como o endereço do HumHub deve estar acessível do ONLYOFFICE Docs.
   • Segredo JWT - especifique o segredo usado para assinar os dados.
     A partir do ONLYOFFICE Docs v7.2, o JWT está habilitado por padrão e a chave secreta é gerada automaticamente. Você precisa habilitá-lo no lado do HumHub também: encontre sua chave secreta no arquivo de configuração do ONLYOFFICE Docs, depois especifique a mesma chave secreta nas configurações do conector. Para mais detalhes, veja a seção Habilitando JWT para a integração ONLYOFFICE e HumHub deste artigo.
5. Endereço do ONLYOFFICE Docs para solicitações internas do servidor - especifique o endereço usado para acessar o Serviço de Edição de Documentos do HumHub.
6. Endereço do servidor para solicitações internas do ONLYOFFICE Docs - especifique o endereço usado para acessar o HumHub do Serviço de Edição de Documentos.

Após configurar a aplicação de integração, clique no botão Enviar para salvar as alterações.

Como funciona

A integração ONLYOFFICE segue a API documentada aqui.

1. Ao criar um novo arquivo, o usuário receberá as opções Documento, Planilha ou Apresentação no menu Criar documento.
2. O navegador invoca o método index no controlador /controllers/CreateController.php.
3. Ou, ao abrir um arquivo existente, o usuário receberá Visualizar documento ou Editar documento dependendo da extensão.
4. Um popup é aberto e o método index do controlador /controllers/OpenController.php é invocado.
5. O aplicativo prepara um objeto JSON com as seguintes propriedades:
   • url - a URL que o ONLYOFFICE Docs usa para baixar o documento;
   • callbackUrl - a URL que o ONLYOFFICE Docs usa para informar sobre o status da edição do documento;
   • key - o hash MD5 aleatório para instruir o ONLYOFFICE Docs se deve baixar o documento novamente ou não;
   • title - o título (nome) do documento;
   • id - a identificação do usuário;
   • name - o nome de usuário.
6. O HumHub pega esse objeto e constrói uma página do template views/open/index.php, preenchendo todos esses valores para que o navegador cliente possa carregar o editor.
7. O navegador cliente faz uma solicitação para a biblioteca JavaScript do ONLYOFFICE Docs e envia para o ONLYOFFICE Docs a configuração DocEditor com as propriedades acima.
8. Então o ONLYOFFICE Docs baixa o documento do HumHub e o usuário começa a editar.
9. O ONLYOFFICE Docs envia uma solicitação POST para callbackUrl para informar ao HumHub que um usuário está editando o documento.
10. Quando todos os usuários e navegadores clientes terminam de editar, eles fecham a janela de edição.
11. Após 10 segundos de inatividade, o ONLYOFFICE Docs envia um POST para callbackUrl informando ao HumHub que os clientes terminaram de editar o documento e o fecharam.
12. O HumHub baixa uma nova versão do documento, substituindo a antiga.

Habilitando JWT para a integração ONLYOFFICE e HumHub

Para proteger documentos de acesso não autorizado, os editores ONLYOFFICE usam o JSON Web Token (JWT). O token é adicionado na configuração quando o Editor de Documentos é inicializado e durante a troca de comandos entre os serviços internos do ONLYOFFICE Docs. A chave secreta é usada para assinar o token web JSON e validar o token mediante solicitação ao ONLYOFFICE Docs.

A partir do ONLYOFFICE Docs v7.2, o JWT está habilitado por padrão e a chave secreta é gerada automaticamente. Você precisa encontrar sua chave secreta no arquivo de configuração do ONLYOFFICE Docs, depois especificar a mesma chave secreta nas configurações do conector.

Passo 1: Encontre sua chave secreta no arquivo de configuração do ONLYOFFICE Docs

1. Abra o arquivo local.json com qualquer editor de texto disponível.
   • Para Linux - /etc/onlyoffice/documentserver/local.json
   • Para Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
   • Para Docker – acesse o container ONLYOFFICE Docs usando o comando docker exec -it <containerID> bash e abra /etc/onlyoffice/documentserver/local.json

     Alternativamente, você pode usar o seguinte comando para encontrar a chave secreta padrão sem abrir o local.json:

     sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

   O arquivo local.json deve ficar assim:

   {"services": {"CoAuthoring": {"token": {"enable": {"request": {"inbox": true,"outbox": true},"browser": true}},"secret": {"inbox": {"string": "yoursecret"},"outbox": {"string": "yoursecret"},"session": {"string": "yoursecret"}}}}}

2. O valor true é especificado em três seções. Isso significa que a validação de token está habilitada.
   • services.CoAuthoring.token.enable.browser
   • services.CoAuthoring.token.enable.request.inbox
   • services.CoAuthoring.token.enable.request.outbox
3. A chave secreta gerada automaticamente é especificada em três seções. Você pode substituir o valor secreto padrão pela sua própria chave secreta. A chave secreta deve ser a mesma nas três seções.
   • services.CoAuthoring.secret.inbox.string
   • services.CoAuthoring.secret.outbox.string
   • services.CoAuthoring.secret.session.string
4. Se você fizer alterações, salve-as e reinicie os serviços para que as mudanças de configuração tenham efeito.

   supervisorctl restart all

Passo 2: Especifique a mesma chave secreta nas configurações do conector

Nas configurações do conector, especifique o mesmo segredo no campo Chave secreta e salve as configurações.