OARS Docs

Appearance

ONLYOFFICE 实施 ​

前置条件 ​

  • OARS 后端可被 ONLYOFFICE Document Server 访问。
  • 浏览器可访问 document-server-url/web-apps/apps/api/documents/api.js。
  • onlyoffice.jwt-secret 至少 32 字节，并与 Document Server JWT 配置一致。
  • 文档记录有 latestFileId，对应 sys_file 文件可读取。

配置项 ​

  • onlyoffice.enabled=true
  • onlyoffice.document-server-url：浏览器加载编辑器脚本使用。
  • onlyoffice.public-base-url：Document Server 回调 OARS 使用，须与其能访问到的对外地址一致（含协议、主机、端口和接口前缀）。
  • onlyoffice.jwt-secret：生成编辑配置、文件访问和回调令牌。未配置或未启用时，回调会被拒绝。

联调链路 ​

  • 前端调用 GET /app/document/{id}/editor-config。
  • 后端生成 document.url 指向 GET /app/document/content/{id}?token=...。
  • ONLYOFFICE 保存时回调 POST /app/document/callback/{id}?token=...，token 必填。
  • 回调状态 2 或 6 会从 Document Server 主机下载新文件（不跟随重定向），写入版本。

排查检查项 ​

  • 编辑器未加载：先查脚本 URL 是否能被浏览器访问。
  • 回调失败：从 Document Server 所在环境访问 OARS 健康检查地址，确认网络可达。
  • 保存不落版本：查 doc_document_log、doc_document_version、后端日志。
  • 报 JWT 错：核对 OARS 和 Document Server 的 JWT 密钥及长度。

生产环境的 Document Server 域名、HTTPS、内外网回调地址和 JWT 配置需按实际部署方式调整。