NodeJS 示例
概述
本示例将帮助您把ONLYOFFICE文档集成到基于Node.js的Web应用程序中。
本示例仅用于测试目的以及演示编辑器的功能。在没有进行适当的代码修改之前,请勿在您自己的服务器上使用此集成示例。如果您启用了测试示例,在投入生产环境之前请将其禁用。
重要安全信息
在使用测试示例时,请牢记以下安全方面的内容:
- 由于无需授权,存储不受未经授权访问的保护。
- 由于参数是由代码根据预先安排的脚本生成的,因此不会对链接中的参数替换进行检查。
- 编辑后保存文件的请求中不会进行数据检查,因为每个测试示例仅适用于来自ONLYOFFICE文档的请求。
- 不禁止从其他网站使用测试示例,因为它们旨在与来自其他域的ONLYOFFICE文档进行交互。
安装
- Windows
- Linux
步骤1. 安装ONLYOFFICE文档
下载并安装ONLYOFFICE文档(打包为文档服务器):
如需了解如何在Windows系统上安装ONLYOFFICE文档,请查看详细指南。
步骤2. 下载用于集成编辑器的Node.js代码
下载包含Node.js示例的压缩包并解压,或者直接从GitHub获取源代码:
curl --output Node.js.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Node.js.Example.zip
tar -xf Node.js.Example.zip
将当前目录切换到项目目录:
cd "Node.js Example"
要将编辑器连接到您的网站,请在config/default.json文件中指定编辑器的安装路径和存储文件夹的路径:
{
"storageFolder": "./files",
"storagePath": "/files",
"siteUrl": "https://documentserver/"
}
其中,documentserver是安装了ONLYOFFICE文档的服务器名称,storageFolder和storagePath是将创建和存储文件的路径。您可以设置一个绝对路径,例如D:\\folder。请注意,在Windows操作系统中,必须使用双反斜杠作为分隔符。您可以注册一个免费的ONLYOFFICE云,并使用其公共IP地址或公共DNS,这些地址或DNS可以在云控制台的实例部分找到。
如果您想尝试配置编辑器,请修改views/editor.ejs文件中的参数。
步骤3. 安装Node.js环境
安装用于运行Node.js项目的Node.js环境。请访问官方网站,根据您的Windows操作系统(32位或64位)选择正确的版本进行安装。
步骤4. 配置JWT
打开config/default.json文件并启用JWT:
{
"server": {
"token": {
"enable": true
}
}
}
同样也要与ONLYOFFICE文档指定相同密钥:
{
"server": {
"token": {
"secret": "secret"
}
}
}
步骤5. 运行Node.js代码
Node.js附带了一个包管理器,即node包管理器(npm),它会随Node.js一起自动安装。要运行Node.js代码,请使用以下npm命令安装项目模块:
npm install
项目文件夹中将会创建一个新的node_modules文件夹。
使用命令提示符运行项目:
node bin/www
在您的浏览器中使用以下地址查看结果:
http://localhost:3000
步骤6. 检查可访问性
如果示例和ONLYOFFICE文档安装在不同的计算机上,请确保安装了示例的服务器能够访问您在配置文件中指定的(替换了documentserver的)地址的ONLYOFFICE文档。同时确保ONLYOFFICE文档反过来也能够访问安装了示例的服务器,使用您在配置文件中指定的(替换了example.com的)地址。
步骤1. 安装ONLYOFFICE文档
下载并安装ONLYOFFICE文档(打包为文档服务器):
如需了解如何在Linux系统上安装ONLYOFFICE文档,请查看详细指南。
步骤2. 安装先决条件并运行带有编辑器的网站
-
安装Node.js:
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs -
下载包含Node.js示例的压缩包并解压,或者直接从GitHub获取源代码:
curl --output Node.js.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Node.js.Example.zip
unzip Node.js.Example.zip -
将当前目录切换到项目目录:
cd "Node.js Example" -
安装依赖项:
npm install -
编辑config/default.json配置文件。指定安装了ONLYOFFICE文档的本地服务器名称。
nano config/default.json编辑以下内容:
{
"storageFolder": "./files",
"storagePath": "/files",
"siteUrl": "https://documentserver/"
}其中,
documentserver是安装了ONLYOFFICE文档的服务器名称,storageFolder和storagePath是将创建和存储文件的路径。请注意,您必须对该文件夹具有读写权限。如果没有,请使用以下命令:sudo chmod -R ugo+rw /{path}启用JWT:
{
"server": {
"token": {
"enable": true
}
}
}同样也要与ONLYOFFICE文档指定相同密钥:
{
"server": {
"token": {
"secret": "secret"
}
}
}您可以注册一个免费的ONLYOFFICE云,并使用其公共IP地址或公共DNS,这些地址或DNS可以在云控制台的实例部分找到。
-
使用Node.js运行项目:
node bin/www -
在您的浏览器中使用以下地址查看结果:
http://localhost:3000
步骤3. 检查可访问性
如果示例和ONLYOFFICE文档安装在不同的计算机上,请确保安装了示例的服务器能够访问您在配置文件中指定的(替换了documentserver的)地址的ONLYOFFICE文档。同时确保ONLYOFFICE文档反过来也能够访问安装了示例的服务器,使用您在配置文件中指定的(替换了example.com的)地址。