安装及部署

OfficeSDK 支持 公网部署 及 私有化部署，适用于集成至业务系统，实现 Word、Excel 等办公文档的在线处理。
请根据实际环境选择合适的部署方式，完成 OfficeSDK 部署。

部署环境要求

硬件要求

服务器配置项	适用值
CPU + 内存	8核 16GB / 16核 32GB / 32核 64GB
存储	512GB SSD/台，可按需扩展

软件要求

项目	要求
操作系统	Linux（Ubuntu、Debian、CentOS）

部署方式

单机部署

第 1 步：下载 OfficeSDK 安装包

前往 Github 仓库或访问《更新日志》章节获取最新版本安装包。

第 2 步：上传安装包至目标服务器

将下载的安装包上传至目标服务器。

scp officesdk.zip user@your-server-ip:/app/

第 3 步：解压安装包

登录服务器，进入安装包所在目录，解压安装包。

cd /app/ && unzip officesdk.zip

第 4 步：启动服务

启动服务。

./start.sh

打开浏览器，访问控制后台 http://localhost:9102/license

第 5 步：完成控制后台的安装引导步骤

添加服务器节点：添加并确认 OfficeSDK 的服务节点；

上传许可证：为每个服务器节点上传许可证；

如果您上传的是付费许可证，则需保证许可证与服务器的信息完全一致，否则会导致许可证校验不通过，您将无法使用 OfficeSDK 服务。

配置域名地址：输入对外提供服务访问的域名地址；

配置回调网关（可选）：您需要自行实现回调服务和一组回调接口，并输入您的回调网关地址。

第 6 步：访问服务页面

完成上述配置后，您将成功访问系统控制后台。
请参考《在线预览编辑服务-接入流程》章节，接入 OfficeSDK 在线预览编辑服务。

集群部署

假设三台应用节点服务器（A、B、C），一台控制节点服务器（M）

第 1 步：下载 OfficeSDK 安装包

前往 Github 仓库或访问《更新日志》章节获取最新版本安装包。

第 2 步：分别上传安装包至四台目标服务器

将下载的安装包上传至目标服务器。

scp officesdk.zip user@your-server-ip:/app/

第 3 步：分别解压安装包

分别登录A、B、C 服务器，进入安装包所在目录，解压安装包到 /app/officesdk 目录。

cd /app/ && unzip officesdk.zip -d officesdk

第 4 步：启动应用节点服务

分别进入 A、B、C 工作节点服务器的 /app/officesdk 目录，执行启动应用服务。

./sysdctl.sh -c "$(pwd)/turboone api" -n officesdk-api

第 5 步：启动控制节点服务

进入 M 控制节点服务器的 /app/officesdk 目录，执行启动控制后台服务。

./sysdctl.sh -c "$(pwd)/turboone admin" -n officesdk-admin

打开浏览器，访问控制后台 http://{ M 服务器IP地址}:9102/license

第 5 步：完成控制后台的安装引导步骤

添加服务器节点：添加 A、B、C 工作节点服务

上传许可证：为每个服务器节点上传许可证；

如果您上传的是付费许可证，则需保证许可证与服务器的信息完全一致，否则会导致许可证校验不通过，您将无法使用 OfficeSDK 服务。

配置域名地址：A、B、C 工作节点服务器对外的负载均衡节点地址

配置回调网关（可选）：您需要自行实现回调服务和一组回调接口，并输入您的回调网关地址。

第 6 步：配置工作节点负载均衡

以 nginx 为例：

  http {
# 定义上游服务器组
upstream file_backend {
    # 基于file_id的哈希负载均衡
    hash $file_id consistent;
    server A地址:9101;  # A服务器IP和端口
        server B地址:9101;  # B服务器IP和端口
        server C地址:9101;  # C服务器IP和端口
}

# 定义上游服务器组（后端节点）
upstream random_backend {
    # 默认使用轮询负载均衡算法
    server A地址:9101;  # A服务器IP和端口
        server B地址:9101;  # B服务器IP和端口
        server C地址:9101;  # C服务器IP和端口
}

# 从URL中提取file_id
map $request_uri $file_id {
    default "";
    ~/v1/api/file/page\?fileID=(?<f>[^&]+) $f;
    # 导出相关接口
    ~/v1/api/files/(?<f>[^/]+)/export $f;
    ~/v1/api/files/(?<f>[^/]+)/export/progress $f;
    # 预览相关接口
    ~/api/files/(?<f>[^/]+)/preview/url $f;
}

server {
    listen 8081;
    server_name 172.1.1.3; # 替换为你的域名或IP

# 公共代理参数
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;

# 添加自定义头显示后端服务器IP
add_header X-Backend-Server $upstream_addr;
add_header X-Backend-Status $upstream_status;

# 文件相关接口 - 基于fileID固定转发
    location ~ ^/v1/api/file/page {
        proxy_pass http://file_backend;
        add_header X-Routing-Type "file_id_based";
    }

    # 导出相关接口
    location ~ ^/v1/api/files/ {
        proxy_pass http://file_backend;
        add_header X-Routing-Type "file_id_based";
    }
  
    # 预览相关接口
    location ~ ^/api/files/ {
        proxy_pass http://file_backend;
        add_header X-Routing-Type "file_id_based";
    }

    location / {
        # 将请求代理到上游服务器组
        proxy_pass http://random_backend;
    add_header X-Routing-Type "random";
    }
}
}

相同 fileId 请求必须请求到相同节点

第 7 步：访问服务页面

完成上述配置后，您将成功访问系统控制后台。
请参考《在线预览编辑服务-接入流程》章节，接入 OfficeSDK 在线预览编辑服务。

为了帮助您更快速接入服务，我们提供了开发 DEMO 作为参考，访问 OfficeSDK github，获取最新版本和示例代码。

部署环境要求#

硬件要求#

软件要求#

部署方式#

单机部署#

集群部署#

部署环境要求

硬件要求

软件要求

部署方式

单机部署

集群部署