Como conectar o ONLYOFFICE ao Mattermost

Sobre a integração entre ONLYOFFICE e Mattermost

O ONLYOFFICE oferece um conector oficial para integrar o ONLYOFFICE Docs com o Mattermost para colaborar em documentos de escritório enviados em chats privados ou em grupo. Você pode baixá-lo do site oficial ou do GitHub. O aplicativo é distribuído sob a licença Apache.

observação

Para saber mais sobre como funciona e como compilar o conector ONLYOFFICE para Mattermost, visite nossa documentação da API.

Principais recursos

• Visualize e edite documentos de texto, planilhas e apresentações usando a opção Abrir arquivo no ONLYOFFICE.
• Gerencie direitos de acesso (Editar ou Ler) do menu de contexto com a opção Alterar direitos de acesso.
• Co-edição de documentos em tempo real: dois modos de co-edição (Rápido e Estrito).
• Live Viewer: usuários com acesso somente leitura podem acompanhar em tempo real as alterações feitas por outros editores, incluindo seus cursores. Disponível apenas para instalações em servidor, habilitado por padrão.
• Visualize o histórico de alterações do arquivo.
• Temas de interface modernos Claro e Escuro para os editores.
• Notificações para administradores quando o editor ONLYOFFICE ficar indisponível (Habilitar notificações de integridade no Console do Sistema).
• Recarregamento automático do editor quando a conexão é restabelecida.
• Suporte JWT para proteger seu tráfego de modo que ninguém além dos usuários com os devidos direitos tenha acesso aos seus documentos.

Formatos suportados

• Para edição:
  • WORD: DOCM, DOCX, DOTM, DOTX
  • CELL: XLSB, XLSM, XLSX, XLTM, XLTX
  • SLIDE: POTM, POTX, PPSM, PPSX, PPTM, PPTX
  • PDF: PDF
• Para visualização:
  • WORD: DOC, DOCM, DOCX, DOT, DOTM, DOTX, EPUB, FB2, FODT, HML, HTM, HTML, HWP, HWPX, MD, MHT, MHTML, ODT, OTT, PAGES, RTF, STW, SXW, TXT, WPS, WPT, XML
  • CELL: CSV, ET, ETT, FODS, NUMBERS, ODS, OTS, SXC, TSV, XLS, XLSB, XLSM, XLSX, XLT, XLTM, XLTX
  • SLIDE: DPS, DPT, FODP, KEY, ODG, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM, PPTX, SXI
  • PDF: DJVU, OXPS, PDF, XPS
  • DIAGRAM: VSDM, VSDX, VSSM, VSSX, VSTM, VSTX

Novidades na versão 2.3.0

Adicionado

• Live Viewer: usuários com acesso somente leitura agora podem ver em tempo real as alterações de outros editores, incluindo seus cursores. Disponível apenas para instalações em servidor, sem necessidade de configuração adicional.
• Suporte aos temas de interface Claro moderno e Escuro moderno (aba Ver → Tema de interface → Claro moderno / Escuro moderno).
• Notificações para administradores sobre desconexão do editor por meio da opção Habilitar notificações de integridade no Console do Sistema.
• Recarregamento automático do editor quando a conexão é restabelecida.

O log de alterações completo está disponível aqui.

Conectando ONLYOFFICE Docs ao Mattermost

Requisitos

• ONLYOFFICE Document Server v6.4.0 (servidor ou versão em nuvem) ou posterior

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

  observação

  Consulte a página de documentação oficial para saber mais sobre a instalação do ONLYOFFICE Docs.

  O ONLYOFFICE Docs e o Mattermost podem ser instalados tanto em computadores diferentes quanto na mesma máquina. Se você usar uma máquina, configure uma porta personalizada para o Document Server.

• Mattermost v. 10.11.0 ou posterior

• Conector ONLYOFFICE v2.3.0 para Mattermost

Instalando o conector ONLYOFFICE para Mattermost

Para conectar o Mattermost, siga estes passos:

1. Instale o Node.js. Consulte a documentação de instalação para mais detalhes.

2. Instale o Go. Consulte a documentação de instalação para mais detalhes. As etapas de instalação variam de acordo com o seu sistema operacional.

3. Instale o make:

   sudo apt install make

4. Clone o branch do plugin:

   git clone https://github.com/ONLYOFFICE/onlyoffice-mattermost.git

5. Vá para a raiz do projeto e busque os submódulos do git:

   cd onlyoffice-mattermost/
   git submodule update --init --recursive

6. Inicie a compilação:

   make

Configurando o Conector ONLYOFFICE para Mattermost

Vá para Console do Sistema → encontre o plugin ONLYOFFICE via busca → Configurar. Habilite o plugin no campo correspondente e especifique os seguintes parâmetros:

1. Endereço do ONLYOFFICE Docs — digite o endereço URL onde o ONLYOFFICE Docs está instalado (ex., https://documentserver).

   observação

   O endereço do ONLYOFFICE Docs deve estar acessível do Mattermost, assim como o endereço do Mattermost deve estar acessível do ONLYOFFICE Docs.

2. Segredo JWT do Document Server — o segredo JWT do document server usado para assinar os dados.

   observação

   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 Mattermost 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 Mattermost deste artigo.

3. Cabeçalho JWT — especifique o cabeçalho JWT.

   observação

   Se a proteção JWT estiver habilitada, é necessário especificar um nome de cabeçalho personalizado, já que a política de segurança do Mattermost bloqueia Cabeçalhos 'Authorization' externos. Este cabeçalho deve ser especificado nas configurações de assinatura do ONLYOFFICE Docs também (mais informações podem ser encontradas aqui).

4. Prefixo JWT — especifique o prefixo JWT.

5. Você também pode se conectar ao servidor de teste público do ONLYOFFICE Docs por um mês marcando a caixa Conexão com o servidor de demonstração do ONLYOFFICE Docs habilitada.

6. Formatos — selecione os formatos de arquivo que devem ser abertos no ONLYOFFICE Docs. Todos os formatos estão habilitados por padrão. Desmarque os formatos para desabilitá-los.

7. Proteção de arquivos apenas pelo proprietário — quando habilitado, somente os proprietários dos arquivos podem proteger/desproteger arquivos pela aba Proteção. Quando desabilitado, a proteção de arquivos está disponível para todos.

8. Habilitar plugins do ONLYOFFICE — quando habilitado, os usuários podem acessar os plugins nos editores. Quando desabilitado, os plugins ficam ocultos.

9. Habilitar macros — quando habilitado, os usuários podem criar e executar macros nos editores. Quando desabilitado, toda a funcionalidade de macros fica oculta.

10. Habilitar notificações de integridade — habilite esta opção para receber notificações de administrador quando o editor ONLYOFFICE ficar indisponível.

Como funciona

A interação usuário-documento é feita tanto no lado do cliente quanto no lado do servidor.

As principais noções usadas ao longo desta documentação são explicadas abaixo.

O lado do cliente inclui:

• Gerenciador de documentos — a lista de documentos exibida no navegador do usuário, onde o usuário pode selecionar o documento necessário e realizar algumas ações com ele (dependendo dos direitos concedidos, o usuário pode abrir o documento para visualizá-lo ou editá-lo e compartilhá-lo com outros usuários).
• Editor de documentos — a interface de visualização e edição de documentos com todos os recursos de edição mais conhecidos disponíveis, usada como meio entre o usuário e o serviço de edição de documentos.

O lado do servidor inclui:

• Serviço de armazenamento de documentos — o serviço do servidor que armazena todos os documentos disponíveis para os usuários com os devidos direitos de acesso. Ele fornece os IDs dos documentos e os links para esses documentos ao gerenciador de documentos que o usuário vê no navegador.
• Serviço de edição de documentos — o serviço do servidor que permite visualizar e editar documentos (caso o usuário tenha os direitos apropriados para isso). A interface do editor de documentos é usada para acessar todos os recursos do serviço de edição de documentos.
• Serviço de comandos de documentos — o serviço do servidor que permite executar comandos adicionais com o serviço de edição de documentos.
• Serviço de conversão de documentos — o serviço do servidor que permite converter o arquivo de documento para o formato Office Open XML apropriado (docx para documentos de texto, xlsx para planilhas e pptx para apresentações) para edição ou download.
• Serviço de criação de documentos — o serviço do servidor que permite criar um documento facilmente, sem a necessidade de executar um editor de processamento de documentos.

Observe que o ONLYOFFICE Document Server inclui o editor de documentos, o serviço de edição de documentos, o serviço de comandos de documentos, o serviço de conversão de documentos e o serviço de criação de documentos. O gerenciador de documentos e o serviço de armazenamento de documentos estão incluídos no Community Server ou devem ser implementados pelos integradores de software que usam o ONLYOFFICE Document Server em seu próprio servidor.

Habilitando JWT para a integração ONLYOFFICE e Mattermost

Para proteger os documentos contra 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 JSON Web Token e validar o token na 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 e 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 — entre no contêiner do ONLYOFFICE Docs usando o comando docker exec -it <containerID> bash e abra /etc/onlyoffice/documentserver/local.json

     Como alternativa, 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 ter a seguinte aparência:

   {
     "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 do 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 alterações 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.

Começar a usar ONLYOFFICE Docs no Mattermost

Visualizando e editando arquivos

• Clique no botão Mais Ações próximo a um arquivo enviado em um chat do Mattermost.

• Escolha a opção Abrir arquivo no ONLYOFFICE do menu de contexto.

  

ou

• Clique no nome do arquivo.

• A janela de pré-visualização do arquivo aparecerá. Para compartilhar o arquivo com outros usuários, clique no botão Compartilhar. Para prosseguir com a edição, clique no botão Editar no ONLYOFFICE.

  

O arquivo será aberto no editor ONLYOFFICE correspondente.

Usuários com acesso somente leitura podem usar o Live Viewer para acompanhar em tempo real as alterações feitas por outros editores, incluindo seus cursores, sem mudar para o modo de edição. O Live Viewer está disponível apenas para instalações em servidor e é habilitado por padrão — nenhuma configuração adicional é necessária. Para saber mais sobre o Live Viewer, consulte a documentação da API.

Alterando direitos de acesso

O remetente tem direitos de acesso de edição e o destinatário tem direitos de acesso de leitura por padrão. Para alterá-los, use a opção Alterar direitos de acesso disponível no menu de contexto do arquivo. Esta opção está disponível apenas para o remetente.

Para co-editar um documento, os usuários autorizados devem abrir o mesmo arquivo juntos.

Em um chat privado:

• Use o menu suspenso no campo Direitos de acesso para @usuário.

  

Em um chat em grupo para todos os membros:

• Use o menu suspenso no campo Direitos de acesso padrão para membros do chat.

  

Em um chat em grupo para um usuário específico:

• Use o menu suspenso no topo, escolha o usuário necessário e clique no botão Adicionar à direita.

  

• O usuário aparecerá na lista abaixo. Altere seus direitos de acesso através de um menu suspenso à direita.

  

observação

Gerenciar direitos de acesso enviará uma notificação de bot para a parte correspondente.

Visualizando histórico de alterações

Todas as alterações no arquivo serão enviadas como notificações contendo o nome de usuário.

As notificações estão disponíveis em uma conversa dedicada. Para abrir a conversa, clique na seta à direita do arquivo.

observação

Para saber mais sobre os problemas mais comuns e as formas de resolvê-los, visite nosso guia de solução de problemas.