跳到主要内容

Strapi

关于 ONLYOFFICE 和 Strapi 集成​

Strapi 是一个用于构建 API 的开源内容管理系统。ONLYOFFICE 提供了一个官方连接器,可以将 ONLYOFFICE 文档 与 Strapi 集成,并在 Strapi 媒体库 中编辑办公文档。您可以从 npm 库或 GitHub 页面获取 ONLYOFFICE 集成插件。该连接器基于 Apache-2.0 许可证分发。

备注

要了解有关 ONLYOFFICE Strapi 连接器工作原理的更多信息,请访问我们的 API 文档页面。

主要功能​

  • 编辑和查看文本文档、电子表格和演示文稿。
  • 实时共同编辑文档:两种共同编辑模式(快速和严格)、跟踪更改模式、批注和内置聊天。
  • JWT 支持,保护您的流量,除具有适当权限的用户外,任何人都无法访问您的文档。

支持的格式​

  • 查看和编辑:DOCX、XLSX、PPTX
  • 仅查看: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

2.0.1 版本的新增内容​

已更改

  • 更新了引擎依赖项

完整的更改日志请见此处。

将 ONLYOFFICE 文档连接到 Strapi​

要求​

  • ONLYOFFICE 文档服务器 v7.1 或更高版本(服务器版或云版)

    您需要一个 ONLYOFFICE 文档 实例,该实例必须可被 Strapi 和任何终端客户端解析并连接。它必须能够直接向 Strapi 发送 POST 请求。

    备注

    请参阅官方文档页面,了解有关安装 ONLYOFFICE 文档的更多信息。

  • Strapi v4.2.0 或更高版本

  • 适用于 Strapi 的 ONLYOFFICE 连接器 v1.1.0

安装适用于 Strapi 的 ONLYOFFICE 集成插件​

  1. 要允许插入包含编辑器的框架并加载 api.js,请将 strapi/config/middlewares.js 文件中的 strapi::security 行替换为以下配置:

    {
    name: "strapi::security",
    config: {
    contentSecurityPolicy: {
    useDefaults: true,
    directives: {
    "script-src": ["'self'", "https:", "http:"],
    "frame-src": ["'self'", "https:", "http:"],
    },
    },
    }
    },

    如果已存在此类配置,只需添加 directives。

  2. 在您的 Strapi 项目中安装插件:

    npm install onlyoffice-strapi --save
  3. 重新构建并重启 Strapi,以便将 ONLYOFFICE 插件包含到管理界面中。运行:

    # using yarn
    yarn build
    yarn develop

    # using npm
    npm run build
    npm run develop

    现在,适用于 Strapi 的 ONLYOFFICE 集成插件已安装并可进行配置。可以通过左侧面板的插件部分访问该插件,名称为 ONLYOFFICE。

    ONLYOFFICE 已安装

配置适用于 Strapi 的 ONLYOFFICE 集成插件​

要在 Strapi 中配置 ONLYOFFICE 集成插件:

  1. 打开左侧面板中的设置部分。

  2. 在全局设置部分,点击 ONLYOFFICE 菜单项。

  3. 在 ONLYOFFICE 设置页面上,输入文档服务器地址,即已安装的 ONLYOFFICE 文档的 URL。

    备注

    Strapi 必须能够访问 ONLYOFFICE 文档的地址,同时 ONLYOFFICE 文档也必须能够访问 Strapi 的地址。

工作原理​

用户与文档的交互在客户端和服务器端同时进行。

下面解释了本文档中使用的主要概念。

客户端包括:

  • 文档管理器 - 在用户浏览器中显示的文档列表,用户可以在其中选择所需的文档并对其执行某些操作(根据所提供的权限,用户可以打开文档进行查看或编辑,也可以与其他用户共享文档)。
  • 文档编辑器 - 具有所有常见文档编辑功能的文档查看和编辑界面,用作用户与文档编辑服务之间的媒介。

服务器端包括:

  • 文档存储服务 - 存储所有可供具有相应访问权限的用户使用的文档的服务器服务。它向用户在浏览器中看到的文档管理器提供文档 ID 和这些文档的链接。
  • 文档编辑服务 - 允许查看和编辑文档(如果用户具有相应权限)的服务器服务。文档编辑器界面用于访问文档编辑服务的所有功能。
  • 文档命令服务 - 允许通过文档编辑服务执行附加命令的服务器服务。
  • 文档转换服务 - 允许将文档文件转换为相应的 Office Open XML 格式(文本文档为 docx,电子表格为 xlsx,演示文稿为 pptx)以便编辑或下载的服务器服务。
  • 文档生成服务 - 允许轻松生成文档而无需实际运行文档处理编辑器的服务器服务。

请注意,ONLYOFFICE 文档服务器包括文档编辑器、文档编辑服务、文档命令服务、文档转换服务和文档生成服务。文档管理器和文档存储服务要么包含在社区服务器中,要么必须由在自己的服务器上使用 ONLYOFFICE 文档服务器的软件集成商实现。

为 ONLYOFFICE 和 Strapi 集成启用 JWT​

JWT 或 JSON Web Token 是在 HTTP 请求中从客户端发送到服务器的字符串,用于验证客户端的真实性。JWT 仅保存在客户端,因此各方之间的传输受到保护并经过数字签名。

令牌使用 JWT(JSON Web Tokens)标准生成。令牌由服务器的密钥签名,因此客户端可以验证令牌是否合法。

ONLYOFFICE 文档会验证令牌。负载中的数据被视为有效,并代替主要参数中的相应数据使用。如果令牌无效,则不执行该命令。要了解更多信息,请阅读 API 安全指南。

要使用 JWT 保护您的文档,

  1. 打开左侧面板中的设置部分。

  2. 在全局设置部分,点击 ONLYOFFICE 菜单项。

  3. 在 ONLYOFFICE 设置页面上,在文档服务器 JWT 密钥字段中输入密钥。更多信息请见此处。

    ONLYOFFICE 插件

    ONLYOFFICE 集成插件配置完成后,您就可以开始使用它了。

在 Strapi 中开始使用 ONLYOFFICE 文档​

为了让用户在 ONLYOFFICE 文档编辑器中编辑来自 Strapi 的办公文档并将更改保存回 Strapi,请上传文件并设置相应的访问权限。

将文件上传到 Strapi​

  1. 在左侧面板的插件部分,打开媒体库页面。

  2. 点击右上角的添加新资源按钮。

    媒体库

  3. 将打开添加新资源窗口。点击顶部面板中的相应选项卡,选择是从您的计算机还是从 URL 上传文件。

    添加新资源

在 Strapi 中查看、编辑和管理文件​

要查看、编辑和共同创作添加到 Strapi 媒体库的文档,

  1. 在左侧面板的插件部分,打开 Strapi 中的 ONLYOFFICE 文件页面。

  2. 要在 ONLYOFFICE 编辑器中打开文件,请点击文件名,或点击右侧的在 ONLYOFFICE 中编辑按钮。

    在 ONLYOFFICE 中查看和编辑

要直接在编辑器中以所需格式保存文件,

  1. 转到文件选项卡。
  2. 点击 下载为... 选项并选择所需的格式。

要直接在编辑器中将文件标记为收藏,请点击顶部工具栏中的 标记为收藏 标记为收藏图标。

要返回文件列表,

  1. 转到文件选项卡。
  2. 点击右侧菜单中的打开文件位置选项。

访问权限​

要管理添加到 Strapi 媒体库的文件的访问权限:

  1. 转到左侧面板的常规部分中的设置选项卡。
  2. 在管理面板部分,转到角色选项卡。
  3. 点击角色名称右侧的编辑图标来编辑角色。

要允许用户编辑文件,请为所需的用户角色设置更新 + 删除访问权限。

要仅允许用户查看文件,请为所需的用户角色设置访问媒体库访问权限。

备注

要了解有关最常见问题及其解决方法的更多信息,请访问我们的故障排除指南。