跳到主要内容

Ruby 集成

Ruby 集成示例是一个小型 Ruby on Rails 应用程序，它可以列出文件、在 ONLYOFFICE 文档中打开文件，并通过回调处理程序将其保存回来。在编写您自己的集成之前，运行此示例即可看到一个完整可用的集成。

警告

本示例仅用于测试。它没有身份验证，不检查链接参数和保存请求，并接受来自任何网站的请求，因此任何能够访问它的人都可以读取和修改其中的文件。请勿在公共服务器上运行此示例，并在投入生产环境之前将其禁用。

先决条件​

步骤 1. 下载示例​

克隆示例仓库，进入 Ruby 示例目录，并获取其子模块：

git clone --depth 1 https://github.com/ONLYOFFICE/document-server-integration
cd document-server-integration/web/documentserver-example/ruby
git submodule update --init --depth 1 .

步骤 2. 配置连接​

本示例没有配置文件，而是从环境变量中读取设置。因此，请在下一步运行示例所用的终端中设置这些变量：

export DOCUMENT_SERVER_PUBLIC_URL=http://documentserver
export STORAGE_PATH=storage
export JWT_SECRET=secret
export EXAMPLE_URL=http://example.com:3000

在 Windows 上，请在命令提示符中使用 set NAME=value，或在 PowerShell 中使用 $env:NAME = "value"，以代替 export。

  • DOCUMENT_SERVER_PUBLIC_URL：安装了 ONLYOFFICE 文档的服务器地址。请将 documentserver 替换为该服务器的名称或 IP 地址。
  • STORAGE_PATH：示例创建和存储文件的文件夹。默认为示例文件夹中的 storage。您可以设置一个绝对路径。运行示例的用户需要对该文件夹具有读写权限。
  • JWT_SECRET：必须与 ONLYOFFICE 文档的 JWT 密钥一致。ONLYOFFICE 文档默认启用 JWT，但在设置此变量之前，示例中的 JWT 处于禁用状态，因此请将其设置为您服务器的密钥。
  • EXAMPLE_URL：ONLYOFFICE 文档访问示例时使用的地址。如果 ONLYOFFICE 文档在另一台计算机上或在 Docker 中运行，则需要设置此项，因为您在浏览器中打开的地址（例如 localhost）在那里指向的是其他位置。

如果您想尝试配置编辑器，请修改 app/models/file_model.rb 文件中 config 方法的参数。

步骤 3. 安装依赖项并运行示例​

make prod
make server-prod

在浏览器中打开 http://localhost:3000。您将看到示例的起始页面，可以在其中上传文件，或者新建文档、电子表格、演示文稿或 PDF 表单。

如果您想改为在 Docker 中将示例与 ONLYOFFICE 文档一起运行，请执行 make compose-prod。该命令会启动 ONLYOFFICE 文档、示例以及一个代理，它们的配置已相互匹配，示例将在 http://localhost 打开。此方式所用的环境变量位于 compose-base.yml 文件中。

故障排除​

  • 文档安全令牌的格式不正确：示例中未启用 JWT（未设置 JWT_SECRET），或者 JWT_SECRET 与 ONLYOFFICE 文档的密钥不一致。
  • 下载失败：ONLYOFFICE 文档无法访问示例。请将 EXAMPLE_URL 设置为 ONLYOFFICE 文档可以解析的地址。