KLINOFFICE 在线文档编辑器支持在Linux 和 Docker 环境部署。

要在本地服务器安装：

1. 下载KLINOFFICE 文档，并根据安装手册指引进行安装：

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

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

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

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

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

   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",
     },
   };
   
   const docEditor = new KlinDocsAPI.DocEditor("placeholder", config);
   

example.com指代部署了文档管理器和文档存储服务的服务器名称。

关于服务端与客户端的交互机制

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

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

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

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

准备工作

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

• 开放必要端口；
• 在 KLINOFFICE 文档的配置文件中调整KLINOFFICE 文档服务器设置；
• 使用SSL 证书将 KLINOFFICE 文档切换至 HTTPS 协议；
• 添加额外字体到 KLINOFFICE 文档以增强编辑器兼容性；
• 自定义编辑器界面主题配色。

健康检查

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

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

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