跳到主要内容

安装 - 自托管

ONLYOFFICE 文档支持在 Windows、Linux 和 Docker 环境部署。

要在本地服务器安装：

  1. 从官网下载 ONLYOFFICE文档开发者版，并根据帮助中心指引进行安装：

  2. 在需要嵌入编辑器的目标 HTML 文件中，定义占位符 div 标签用于传递编辑器参数：

    <div id="placeholder"></div>
    <script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script>

    documentserver 指代已安装 ONLYOFFICE 文档的服务器名称。若本地部署，此处应为本地服务器地址（如 http://localhost）。

    https://documentserver/web-apps/apps/api/documents/api.js 是 API JavaScript 文件的默认访问路径。

    自 8.1 版本起，建议在 URL QueryString 中添加包含 key 值的 shardkey 参数。例如：?shardkey=Khirz6zTPdfd7。此参数支持请求负载均衡。

  3. 定义包含可变参数的页面代码：

    const docEditor = new DocsAPI.DocEditor("placeholder", config)

    其中 config 为配置对象：

    const config = {
      document: {
        fileType: "docx",
        key: "Khirz6zTPdfd7",
        title: "Example Document Title.docx",
        url: "https://example.com/url-to-example-document.docx",
      },
      documentType: "word",
      editorConfig: {
        callbackUrl: "https://example.com/url-to-callback.ashx",
      },
    }

    example.com 指代部署了文档管理器和文档存储服务的服务器名称。关于服务端与客户端的交互机制，请参阅工作原理章节。

    此后，docEditor 对象即可调用文档编辑器方法。

    以上配置包含确保 ONLYOFFICE 文档正常启动的所有必要参数。

  4. 添加非必需的可选参数，以实现文档的多样化控制（如调整权限、显示自定义信息等）。具体参数列表及用法请参阅高级参数章节。

  5. 为请求添加加密签名令牌，防止关键参数被篡改。

准备工作​

在使用 ONLYOFFICE 文档 API 前，建议根据需求完成以下配置：

健康检查​

向 /healthcheck 发送 GET 请求可验证编辑器可用性。该请求将检测数据库、消息代理、Redis 连接和存储服务的运行状态。

正常响应应为 true，表示编辑器已就绪。

若检测失败，请检查是否已正确完成上述安装步骤。

后续步骤​