Strapi

Sobre a integração entre ONLYOFFICE e Strapi

O Strapi é um sistema gerenciador de conteúdo de código aberto usado para construir APIs. O ONLYOFFICE oferece um conector oficial para integrar o ONLYOFFICE Docs com o Strapi e editar documentos de escritório na sua biblioteca de mídia do Strapi. Você pode obter o plugin de integração ONLYOFFICE da biblioteca npm ou da página do GitHub. O conector é distribuído sob a licença Apache-2.0.

Principais recursos
  • Edição e visualização de documentos de texto, planilhas e apresentações.
  • Co-edição de documentos em tempo real: dois modos de co-edição (Rápido e Estrito), o modo Controlar Alterações, comentários e chat integrado.
  • Suporte JWT para proteger seu tráfego de modo que ninguém possa ter acesso aos seus documentos com exceção dos usuários com os devidos direitos.
Formatos suportados
  • Para visualização e edição: DOCX, XLSX, PPTX
  • Apenas para visualização: DOC, DOCX, DOCM, DOT, DOTX, DOTM, ODT, FODT, OTT, RTF, TXT, HTML, HTM, MHT, XML, PDF, DJVU, FB2, EPUB, XPS, XLS, XLSX, XLSM, XLT, XLTX, XLTM, ODS, FODS, OTS, CSV, PPS, PPSX, PPSM, PPT, PPTX, PPTM, POT, POTX, POTM, ODP, FODP, OTP
O que há de novo na versão 2.0.1?

Alterado

  • Dependências do motor atualizadas

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

Conectando o ONLYOFFICE Docs ao Strapi

Requisitos
  • ONLYOFFICE Document Server v7.1 (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 Strapi quanto de qualquer cliente final. Deve ser capaz de fazer POST diretamente para o Strapi.

    Consulte a página de documentação oficial para saber mais sobre a instalação do ONLYOFFICE Docs.
  • Strapi v4.2.0 ou posterior
  • Conector ONLYOFFICE v1.1.0 para Strapi
Instalando o plugin de integração ONLYOFFICE para Strapi
  1. Para permitir a inserção de um frame com o editor e carregamento do api.js, substitua a linha strapi::security no arquivo strapi/config/middlewares.js pela seguinte configuração:
    
    {
      name: "strapi::security",
      config: {
        contentSecurityPolicy: {
          useDefaults: true,
          directives: {
            "script-src": ["'self'", "https:", "http:"],
            "frame-src": ["'self'", "https:", "http:"],
          },
        },
      }
    },  
                        

    Se tal configuração já existir, você só precisa adicionar directives.

  2. Instale o plugin no seu projeto Strapi:
    npm install onlyoffice-strapi --save
  3. Reconstrua e reinicie o Strapi para incluir o plugin ONLYOFFICE na interface administrativa. Execute:
    
    # usando yarn
    yarn build
    yarn develop      
    # usando npm
    npm run build
    npm run develop
    

    Agora o plugin de integração ONLYOFFICE para Strapi está instalado e pronto para ser configurado. O plugin pode ser acessado através do painel esquerdo na seção Plugins sob o nome ONLYOFFICE.

    ONLYOFFICE instaladoONLYOFFICE instalado
Configurando o plugin de integração ONLYOFFICE para Strapi

Para configurar o plugin de integração ONLYOFFICE no Strapi:

  1. Abra a seção Configurações no painel esquerdo.
  2. Na seção Configurações globais, clique no item de menu ONLYOFFICE.
  3. Na página de configurações ONLYOFFICE, digite o Endereço do servidor de documentos, ou seja, a URL do ONLYOFFICE Docs instalado.
    O endereço do ONLYOFFICE Docs deve estar acessível do Strapi, assim como o endereço do Strapi deve estar acessível do ONLYOFFICE Docs.
Como funciona

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

Os principais conceitos usados ao longo da documentação atual são explicados abaixo.

O lado do cliente inclui:

  • Gerenciador de documentos - a lista dos documentos exibida no navegador do usuário onde o usuário pode selecionar o documento necessário e executar algumas ações com ele (dependendo dos direitos fornecidos, o usuário pode abrir o documento para visualizá-lo ou editá-lo, compartilhar o documento com outros usuários).
  • Editor de documentos - a interface de visualização e edição de documentos com todos os recursos de edição de documentos 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 aos usuários com os direitos de acesso apropriados. Ele fornece os IDs dos documentos e 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 executar a visualização e edição de documentos (caso o usuário tenha os direitos apropriados para fazer isso). A interface do editor de documentos é usada para acessar todos os recursos do serviço de edição de documentos.
  • Serviço de comando 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 sua edição ou download.
  • Serviço de construção de documentos - o serviço do servidor que permite construir um documento facilmente sem a necessidade de executar realmente um editor de processamento de documentos.

Observe que o ONLYOFFICE Document Server inclui o editor de documentos, serviço de edição de documentos , serviço de comando de documentos, serviço de conversão de documentos e serviço de construçã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 Strapi

JWT ou JSON Web Token é uma string enviada do cliente para o servidor dentro da requisição HTTP para validar a autenticidade do cliente. O JWT é salvo apenas no lado do cliente, então a transmissão entre as partes é protegida e assinada digitalmente.

O token é gerado usando o padrão JWT (JSON Web Tokens). Os tokens são assinados pela chave do servidor, então o cliente é capaz de verificar que o token é legítimo.

O ONLYOFFICE Docs valida o token. Os dados do payload são considerados válidos e são usados ao invés dos dados correspondentes dos parâmetros principais. Se o token for inválido, o comando não é executado. Para saber mais, leia o guia de Segurança da API.

Para proteger seus documentos com JWT,

  1. Abra a seção Configurações no painel esquerdo.
  2. Na seção Configurações globais, clique no item de menu ONLYOFFICE.
  3. Na página de configurações ONLYOFFICE, digite a chave secreta no campo Chave secreta JWT do servidor de documentos . Mais informações podem ser encontradas aqui.
    Plugin ONLYOFFICEPlugin ONLYOFFICE

    Agora que o plugin de integração ONLYOFFICE está configurado, você pode começar a usá-lo.

Começar a usar ONLYOFFICE Docs no Strapi

Para permitir que os usuários editem os documentos de escritório do Strapi nos editores ONLYOFFICE Docs e salvem as alterações de volta ao Strapi, carregue os arquivos e defina os direitos de acesso correspondentes.

Carregando arquivos para o Strapi
  1. Na seção Plugins no painel esquerdo, abra a página Biblioteca de Mídia.
  2. Clique no botão Adicionar novos recursos no canto superior direito.
    Biblioteca de MídiaBiblioteca de Mídia
  3. A janela Adicionar novos recursos se abre. Escolha se você deseja carregar um arquivo do seu computador ou de URL clicando na aba correspondente no painel superior.
    Adicionar novos recursosAdicionar novos recursos
Visualizando, editando e gerenciando arquivos no Strapi

Para visualizar, editar e coautoria de documentos adicionados à Biblioteca de Mídia do Strapi,

  1. Na seção Plugins no painel esquerdo, abra a página de arquivos ONLYOFFICE dentro do Strapi.
  2. Para abrir o arquivo no editor ONLYOFFICE, clique no nome do arquivo ou clique no botão Editar no ONLYOFFICE à direita.
    Visualizar e editar no ONLYOFFICEVisualizar e editar no ONLYOFFICE

Para salvar arquivos no formato necessário diretamente no editor,

  1. Vá para a aba Arquivo.
  2. Clique na opção Baixar como... e escolha o formato necessário.

Para marcar arquivos como favoritos diretamente no editor, clique no ícone Marcar como favorito Marcar como favorito na barra de ferramentas superior.

Para retornar à lista de arquivos,

  1. Vá para a aba Arquivo.
  2. Clique na opção Abrir local do arquivo no menu à direita.
Direitos de acesso

Para gerenciar direitos de acesso aos arquivos adicionados à Biblioteca de Mídia do Strapi:

  1. Vá para a aba Configurações localizada na seção Geral no painel esquerdo.
  2. Na seção Painel de administração, vá para a aba Funções.
  3. Edite a função clicando no ícone Editar à direita do nome da função.

Para permitir que os usuários editem arquivos, defina os direitos de acesso Atualizar + Excluir para a função de usuário necessária.

Para permitir que os usuários apenas visualizem arquivos, defina o direito de acesso Acessar a Biblioteca de Mídia para a função de usuário necessária.

Host ONLYOFFICE Docs on your own server or use it in the cloud

Article with the tag:
Browse all tags