Confluence

Como funciona

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

1. O usuário navega até os anexos do Confluence e seleciona a ação Editar no ONLYOFFICE.
2. O Confluence faz uma solicitação ao OnlyOfficeEditorServlet (URL na forma: /plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).
3. O Confluence envia um documento para o serviço de armazenamento de documentos do ONLYOFFICE e recebe um link temporário.
4. O Confluence prepara um objeto JSON com as seguintes propriedades:
   • url - o link temporário 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;
   • docserviceApiUrl - a URL à qual o cliente precisa responder ao ONLYOFFICE Docs (fornecida pela propriedade files.docservice.url.api);
   • key - o UUID para instruir o ONLYOFFICE Docs se deve baixar o documento novamente ou não;
   • title - o título (nome) do documento.
5. O Confluence usa este objeto para gerar uma página a partir de um template freemarker, preenchendo-a com os valores fornecidos para permitir que o navegador cliente carregue o editor.
6. O navegador cliente faz uma solicitação à biblioteca JavaScript do ONLYOFFICE Docs e envia ao ONLYOFFICE Docs a configuração do DocEditor com as propriedades acima.
7. Em seguida, o ONLYOFFICE Docs baixa o documento do Confluence e o usuário começa a editar.
8. Quando todos os usuários e navegadores cliente terminam de editar, eles fecham a janela de edição.
9. Após 10 segundos de inatividade, o ONLYOFFICE Docs envia um POST para callbackUrl informando ao Confluence que os clientes terminaram de editar o documento e o fecharam.
10. O Confluence baixa uma nova versão do documento, substituindo a antiga.

Habilitando JWT para a integração entre ONLYOFFICE e Confluence

Para proteger documentos contra acesso não autorizado, os editores ONLYOFFICE usam o JSON Web Token (JWT). O token é adicionado na configuração quando o Document Editor é 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 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, então 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

     Se preferir, 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 esta 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. 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.

Conectando ao ONLYOFFICE Docs demo

Se você quiser testar os editores online ONLYOFFICE no Confluence sem instalar o ONLYOFFICE Docs:

1. Vá para Administração do Confluence > Gerenciar aplicativos > Conector ONLYOFFICE para Confluence > Configurar.
2. Marque a caixa de seleção Conectar ao servidor demo do ONLYOFFICE Document Server.
3. Clique no botão Salvar.