Liferay

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 Liferay quanto de qualquer cliente final. Deve ser capaz de fazer POST para o Liferay diretamente.

  Consulte a página de documentação oficial para saber mais sobre a instalação do ONLYOFFICE Docs.
• Liferay CE Portal 7.2 GA1+, Liferay DXP 7.2 GA1+, Liferay CE Portal 7.3 GA1+, Liferay DXP 7.3 GA1+, Liferay CE Portal 7.4 GA1+, Liferay CE 7.4 GA44 - GA73, Liferay DXP 7.4 U44 - U73
• Conector ONLYOFFICE v2.2.0 para Liferay.

Instalando o Conector ONLYOFFICE para Liferay

Você pode instalar o conector ONLYOFFICE usando o Gerenciador de Aplicativos.

Para instalá-lo usando o Gerenciador de Aplicativos:

1. Navegue para Painel de Controle > Sistema > Gerenciador de Aplicativos.
2. Clique no botão Opções.
3. Clique no botão Carregar.
4. Na janela aberta, escolha o arquivo do aplicativo ONLYOFFICE.

Quando a instalação estiver concluída, o aplicativo estará pronto para uso.

Se você estiver compilando o conector por conta própria, simplesmente coloque o arquivo .jar compilado da pasta build\libs em /opt/liferay/deploy. O Liferay o instalará automaticamente.

Compilando Conector ONLYOFFICE para Liferay

Simplesmente execute gradle build. O arquivo .jar de saída será colocado dentro do diretório build/libs.

Configurando o conector ONLYOFFICE para Liferay

Vá para Painel de Controle > Configuração > Configurações do Sistema. Na seção Plataforma, escolha a categoria Conectores e selecione ONLYOFFICE.

Aqui você pode configurar as seguintes definições:

• Endereço do ONLYOFFICE Docs - especifique o endereço URL onde o Serviço de Edição de Documentos está instalado.
  O endereço do ONLYOFFICE Docs deve estar acessível do Liferay, assim como o endereço do Liferay deve estar acessível do ONLYOFFICE Docs.
• Endereço do ONLYOFFICE Docs para solicitações internas do servidor - especifique o endereço que é usado para acessar o Serviço de Edição de Documentos do Liferay.
• Endereço do servidor para solicitações internas do ONLYOFFICE Docs - especifique o endereço que é usado para acessar o Liferay do Serviço de Edição de Documentos.
• Chave secreta - 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 Liferay 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 Liferay deste artigo.
• Habilitar Force Save - ative a caixa de seleção para manter versões intermediárias do documento durante a edição.
• Habilitar Pré-visualização Web ONLYOFFICE - ative a caixa de seleção para habilitar a pré-visualização de arquivos.

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

Como funciona

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

1. O usuário navega para a seção Documentos e Mídia no Liferay e seleciona a ação Editar no ONLYOFFICE.
2. O Liferay prepara um objeto JSON para o Document Server 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 fileVersionId para instruir o ONLYOFFICE Docs se deve baixar o documento novamente ou não;
   • title: o título (nome) do documento.
3. 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.
4. Então o ONLYOFFICE Docs baixa o documento do Liferay e o usuário começa a editar.
5. O ONLYOFFICE Docs envia uma solicitação POST para callbackUrl para informar ao Liferay que um usuário está editando o documento.
6. O Liferay bloqueia o documento, mas ainda permite que outros usuários com acesso de escrita colaborem em tempo real com o ONLYOFFICE Docs mantendo a Ação presente.
7. Quando todos os usuários e navegadores clientes terminam de editar, eles fecham a janela de edição.
8. Após 10 segundos de inatividade, o ONLYOFFICE Docs envia um POST para callbackUrl informando ao Liferay que os clientes terminaram de editar o documento e o fecharam.
9. O Liferay baixa uma nova versão do documento, substituindo a antiga.

Habilitando JWT para a integração ONLYOFFICE e Liferay

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.