onlyoffice/4testing-docs-example

ONLYOFFICE Docs Node.js 集成示例文档

1. 镜像概述和主要用途

本文档提供的示例用于将ONLYOFFICE Docs（Document Server）集成到基于Node.js的Web应用中。该示例主要用于测试环境和演示ONLYOFFICE文档编辑器的功能，不得直接用于生产环境。

注意：本示例仅为功能演示和测试目的设计，未经适当代码修改前，禁止在生产服务器上使用。若已部署测试示例，在切换至生产环境前必须禁用。

2. 核心功能与特性

• 与ONLYOFFICE Document Server无缝集成，提供在线文档编辑能力
• 支持自定义文件存储路径配置
• 允许通过配置文件调整编辑器高级参数
• 基于Node.js运行时环境，提供Web访问界面

3. 使用场景与适用范围

• 开发环境中验证ONLYOFFICE编辑器集成方案
• 演示ONLYOFFICE Docs的文档编辑功能
• 不适用于生产环境部署，缺乏必要的安全防护机制

4. 安装部署

4.1 Windows系统部署

4.1.1 安装ONLYOFFICE Docs

下载并安装ONLYOFFICE Docs（Document Server）。详细安装指南参见Windows版Document Server安装文档。

4.1.2 获取并配置Node.js示例代码

1. 下载Node.js集成示例并解压
2. 编辑config/default.json文件，配置存储路径和Document Server地址：

json
"storageFolder": "./files",
"storagePath": "/files",
"siteUrl": "https://documentserver/"

• documentserver：安装ONLYOFFICE Document Server的服务器名称或IP地址
• storageFolder：本地文件存储路径（支持绝对路径，Windows系统需使用双反斜杠，如D:\\docs）
• storagePath：文件访问的URL路径

3. 如需自定义编辑器行为，可修改views/editor.ejs文件中的高级参数

4.1.3 安装Node.js环境

访问Node.js官方网站，下载并安装适用于Windows系统的Node.js版本（32位或64位）。

4.1.4 运行项目

通过命令提示符（cmd）执行以下步骤：

1. 切换至项目目录：

cmd
cd /d "C:\path\to\Node.js Example"

2. 安装项目依赖：

cmd
npm install

3. 启动应用：

cmd
node bin/www

4. 在浏览器中访问：http://localhost:3000

4.1.5 网络可访问性检查

若示例与Document Server部署在不同服务器，需确保：

• 示例服务器可通过配置的siteUrl访问Document Server
• Document Server可访问示例服务器（配置中替换example.com的地址）

4.2 Linux系统部署

4.2.1 安装ONLYOFFICE Docs

下载并安装ONLYOFFICE Docs（Document Server）。详细安装指南参见Linux版Document Server安装文档。

4.2.2 安装依赖与配置项目

1. 安装Node.js：

bash
curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

2. 下载并解压示例代码：

bash
wget https://api.onlyoffice.com/app_data/editor/Node.js%20Example.zip
unzip "Node.js Example.zip"
cd "Node.js Example/"

3. 安装项目依赖：

bash
npm install

4. 配置config/default.json文件：

bash
nano config/default.json

修改以下配置项：

json
"storageFolder": "./files",
"storagePath": "/files",
"siteUrl": "https://documentserver/"

确保storageFolder路径具有读写权限，若无权限可执行：sudo chmod -R ugo+rw /path/to/storage

4.2.3 运行项目

bash
nodejs bin/www

在浏览器中访问：http://localhost:3000

4.2.4 网络可访问性检查

若示例与Document Server部署在不同服务器，需确保：

• 示例服务器可通过配置的siteUrl访问Document Server
• Document Server可访问示例服务器（配置中替换example.com的地址）

5. 配置说明

5.1 核心配置参数（config/default.json）

5.2 编辑器高级配置（views/editor.ejs）

通过修改views/editor.ejs文件可自定义编辑器行为，支持配置的参数包括但不限于：

• 编辑器高度、宽度
• 工具栏显示选项
• 协作编辑模式
• 文档权限设置

具体参数说明参见ONLYOFFICE编辑器高级API文档。

6. 安全注意事项

测试示例存在以下安全风险，生产环境必须进行加固：

• 无授权保护：未实现用户认证机制，任何访问者可操作存储文件
• 参数校验缺失：未验证URL参数合法性，存在参数注入风险
• 请求验证不足：仅接受来自Document Server的保存请求，未对请求数据完整性进行校验
• 跨域限制缺失：允许从其他域名访问，存在跨站请求伪造风险

生产环境部署前，需针对上述问题添加身份认证、数据校验和跨域保护机制。