跳到主要内容

Mattermost

关于 ONLYOFFICE 和 Mattermost 的集成​

ONLYOFFICE 提供了一个官方连接器,将 ONLYOFFICE 文档 与 Mattermost 集成,以便在私人或群组聊天中协作处理办公文档。您可以从官方网站或 GitHub 下载。该应用程序在 Apache 许可证下分发。

备注

要了解更多关于其工作原理以及如何编译 ONLYOFFICE 的 Mattermost 连接器,请访问我们的 API 文档。

主要功能​

  • 使用在 ONLYOFFICE 中打开文件选项查看和编辑文本文档、电子表格和演示文稿。
  • 通过上下文菜单中的更改访问权限选项管理访问权限(编辑或阅读)。
  • 实时共同编辑文档:两种共同编辑模式(快速和严格)。
  • Live Viewer:具有只读访问权限的用户可以实时查看其他编辑者对文档所做的更改,包括他们的光标。仅适用于服务器安装,默认启用。
  • 查看文件更改历史。
  • 编辑器的现代浅色和深色界面主题。
  • 当 ONLYOFFICE 编辑器不可用时向管理员发送通知(系统控制台中的启用健康通知)。
  • 连接恢复后自动重新加载编辑器。
  • JWT 支持以保护您的流量,确保只有具有适当权限的用户才能访问您的文档。

支持的格式​

  • 用于编辑:
    • WORD:DOCM, DOCX, DOTM, DOTX
    • CELL:XLSB, XLSM, XLSX, XLTM, XLTX
    • SLIDE:POTM, POTX, PPSM, PPSX, PPTM, PPTX
    • PDF:PDF
  • 用于查看:
    • 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

版本 2.3.0 的新功能​

新增

  • Live Viewer:具有只读访问权限的用户现在可以实时查看其他编辑者所做的更改,包括他们的光标。仅适用于服务器安装,无需额外配置。
  • 支持现代浅色和现代深色界面主题(视图选项卡 → 界面主题 → 现代浅色 / 现代深色)。
  • 通过系统控制台中的启用健康通知选项,在编辑器断开连接时向管理员发送通知。
  • 连接恢复后自动重新加载编辑器。

完整的变更日志可以在这里查看。

将 ONLYOFFICE 文档连接到 Mattermost​

要求​

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

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

    备注

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

    ONLYOFFICE 文档和 Mattermost 可以安装在不同的计算机上,也可以安装在同一台机器上。如果使用一台机器,请为文档服务器设置自定义端口。

  • Mattermost v. 10.11.0 或更高版本

  • 适用于 Mattermost 的 ONLYOFFICE 连接器 v2.3.0

为 Mattermost 安装 ONLYOFFICE 连接器​

要连接 Mattermost,请按照以下步骤操作:

  1. 安装 Node.js。有关更多详细信息,请参阅安装文档。

  2. 安装 Go。有关更多详细信息,请参阅安装文档。安装步骤因操作系统而异。

  3. 安装 make:

    sudo apt install make
  4. 克隆插件分支:

    git clone https://github.com/ONLYOFFICE/onlyoffice-mattermost.git
  5. 进入项目根目录并获取 git 子模块:

    cd onlyoffice-mattermost/
    git submodule update --init --recursive
  6. 开始构建:

    make

配置 Mattermost 的 ONLYOFFICE 连接器​

转到系统控制台 → 通过搜索找到 ONLYOFFICE 插件 → 配置。在相应的字段中启用插件,并指定以下参数:

  1. ONLYOFFICE 文档地址 - 输入安装 ONLYOFFICE 文档的 URL 地址(例如,https://documentserver)。

    备注

    ONLYOFFICE 文档的地址必须可以从 Mattermost 访问,同时 Mattermost 的地址也必须可以从 ONLYOFFICE 文档访问。

  2. 文档服务器 JWT 密钥 - 用于签署数据的文档服务器 JWT 密钥。

    备注

    从 ONLYOFFICE 文档 v7.2 开始,JWT 默认启用,密钥会自动生成。您需要在 Mattermost 端也启用它:在 ONLYOFFICE 文档配置文件中找到您的密钥,然后在连接器设置中指定相同的密钥。有关更多详细信息,请参阅本文的为 ONLYOFFICE 和 Mattermost 集成启用 JWT部分。

  3. JWT 头 - 指定 JWT 头。

    备注

    如果启用了 JWT 保护,则需要指定自定义头名称,因为 Mattermost 的安全策略阻止外部 'Authorization' 头。此头也应在 ONLYOFFICE 文档签名设置中指定(更多信息可以在这里找到)。

  4. JWT 前缀 - 指定 JWT 前缀。

  5. 您还可以通过选中已启用与 ONLYOFFICE 文档演示服务器的连接复选框,连接到 ONLYOFFICE 文档的公共测试服务器,为期一个月。

  6. 格式 - 选择应在 ONLYOFFICE 文档中打开的文件格式。默认情况下,所有格式均已启用。取消选中格式即可将其禁用。

  7. 仅限所有者进行文件保护 - 启用后,只有文件所有者可以通过保护选项卡保护/取消保护文件。禁用后,所有人都可以使用文件保护。

  8. 启用 ONLYOFFICE 插件 - 启用后,用户可以在编辑器中访问插件。禁用后,插件将被隐藏。

  9. 启用宏 - 启用后,用户可以在编辑器中创建和运行宏。禁用后,所有宏功能都将被隐藏。

  10. 启用健康通知 - 启用此选项,以便在 ONLYOFFICE 编辑器不可用时接收管理员通知。

ONLYOFFICE 配置

工作原理​

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

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

客户端包括:

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

服务器端包括:

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

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

为 ONLYOFFICE 和 Mattermost 集成启用 JWT​

为了保护文档免受未经授权的访问,ONLYOFFICE 编辑器使用 JSON Web 令牌(JWT)。令牌在文档编辑器初始化时以及 ONLYOFFICE 文档内部服务之间交换命令时添加到配置中。密钥用于签署 JSON Web 令牌并在向 ONLYOFFICE 文档发出请求时验证令牌。

从 ONLYOFFICE 文档 v7.2 开始,JWT 默认启用,密钥会自动生成。您需要在 ONLYOFFICE 文档配置文件中找到您的密钥,然后在连接器设置中指定相同的密钥。

步骤 1:在 ONLYOFFICE 文档配置文件中找到您的密钥

  1. 使用任何可用的文本编辑器打开 local.json 文件。

    • 对于 Linux — /etc/onlyoffice/documentserver/local.json

    • 对于 Windows — %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json

    • 对于 Docker — 使用 docker exec -it <containerID> bash 命令进入 ONLYOFFICE 文档容器,并打开 /etc/onlyoffice/documentserver/local.json

      或者,您可以使用以下命令在不打开 local.json 的情况下查找默认密钥:

      sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

    local.json 文件应如下所示:

    {
    "services": {
    "CoAuthoring": {
    "token": {
    "enable": {
    "request": {
    "inbox": true,
    "outbox": true
    },
    "browser": true
    }
    },
    "secret": {
    "inbox": {
    "string": "yoursecret"
    },
    "outbox": {
    "string": "yoursecret"
    },
    "session": {
    "string": "yoursecret"
    }
    }
    }
    }
    }
  2. 值 true 在三个部分中指定。这意味着令牌验证已启用。

    • services.CoAuthoring.token.enable.browser
    • services.CoAuthoring.token.enable.request.inbox
    • services.CoAuthoring.token.enable.request.outbox
  3. 自动生成的密钥在三个部分中指定。您可以将默认密钥值替换为您自己的密钥。三个部分中的密钥必须相同。

    • services.CoAuthoring.secret.inbox.string
    • services.CoAuthoring.secret.outbox.string
    • services.CoAuthoring.secret.session.string
  4. 如果您进行了更改,请保存并重新启动服务,使配置更改生效。

    supervisorctl restart all

步骤 2:在连接器设置中指定相同的密钥

在连接器设置中,在密钥字段中指定相同的密钥并保存设置。

在 Mattermost 中开始使用 ONLYOFFICE 文档​

查看和编辑文件​

  • 点击 Mattermost 聊天中发送的文件旁边的更多操作按钮 更多操作按钮。

  • 从上下文菜单中选择在 ONLYOFFICE 中打开文件选项。

    文件菜单

或

  • 点击文件名。

  • 文件预览窗口将出现。要与其他用户共享文件,请点击共享按钮。要继续编辑,请点击在 ONLYOFFICE 中编辑按钮。

    文件预览

文件将在相应的 ONLYOFFICE 编辑器中打开。

具有只读访问权限的用户可以使用 Live Viewer 实时查看其他编辑者所做的更改,包括他们的光标,而无需切换到编辑模式。Live Viewer 仅适用于服务器安装,默认启用——无需额外配置。要了解有关 Live Viewer 的更多信息,请参阅 API 文档。

更改访问权限​

发送者默认具有编辑访问权限,接收者默认具有阅读访问权限。要更改它们,请使用文件上下文菜单中的更改访问权限选项。此选项仅对发送者可用。

要共同编辑文档,授权用户应一起打开同一个文件。

在私人聊天中:

  • 使用访问权限给 @user字段中的下拉菜单。

    私人聊天

在群组聊天中对所有成员:

  • 使用聊天成员的默认访问权限字段中的下拉菜单。

    群组聊天,所有成员

在群组聊天中对特定用户:

  • 使用顶部的下拉菜单,选择所需的用户,然后点击右侧的添加按钮。

    群组聊天,特定用户

  • 用户将出现在下面的列表中。通过右侧的下拉菜单更改他们的访问权限。

    群组聊天,特定用户

备注

管理访问权限将向相应方发送机器人通知。

查看更改历史​

对文件的所有更改将作为包含用户名的通知发送。

版本历史

通知可在专用线程中查看。要打开线程,请点击文件右侧的箭头。

版本历史

备注

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