如何用Ruby将在线编辑器集成到您自己的网站中

概述

此示例将帮助您将 ONLYOFFICE 文档集成到用Ruby编写的 Web 应用程序中。

它用于测试和演示编辑器的功能。如果没有适当的代码修改，请不要在自己的服务器上使用此集成示例。如果您启用了测试示例，请在投入产品之前将其禁用。

重要安全信息

在使用测试示例时，请记住以下几方面的安全事项：

由于不需要授权，因此无法保护存储免受未经授权的访问。
没有检查链接中的参数替换，因为参数是由代码根据预先安排的脚本生成的。
在编辑后保存文件的请求中没有数据检查，因为每个测试示例仅适用于来自 ONLYOFFICE 文档服务器的请求。
没有禁止使用来自其他网站的测试示例，因为它们用于与来自另一个域的 ONLYOFFICE 文档服务器进行交互。

步骤1. 安装必备组件并运行带编辑器的网站

Python示例提供了各种安装选项，但我们强烈建议使用Docker。

选项1. 使用Docker

要使用 Docker 运行示例，您将需要 Docker Desktop 4.17.0 或 Docker Engine 20.10.23 与 Docker Compose 2.15.1。此外，您可能需要考虑安装 GNU Make 4.4.1，尽管它是可选的。这些是工具所需的最低版本。

安装完所有内容后，下载发布的压缩文件并将其解压：

curl --output Ruby.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Ruby.Example.zip
unzip Ruby.Example.zip

然后打开示例目录和容器:

cd "Ruby Example"
make compose-prod

>默认情况下，服务器从localhost:80启动。

要配置示例，您可以编辑compose-base.yml。有关环境变量的更多信息，请参阅下面。

选项 2. 在本地计算机上

在深入研究示例之前，您需要安装 ONLYOFFICE Docs。查看详细指南，了解如何在 Windows， Linux，或 Docker上安装它。

要在本地计算机上运行该示例，您需要 Ruby 3.2.2 和 Bundler 2.4.10.此外，您可能需要考虑安装 GNU Make 4.4.1，尽管它是可选的。这些是工具所需的最低版本。

安装完所有内容后，下载发布的压缩文件并将其解压：

curl --output Ruby.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Ruby.Example.zip
unzip Ruby.Example.zip

然后打开示例目录，安装依赖项，并启动服务器:

cd "Ruby Example"
make prod
make server-prod

默认情况下，服务器从 0.0.0.0:3000启动.

要配置该示例，您可以在启动服务器的命令之前传递环境变量。有关环境变量的更多信息，请参阅下面。

步骤2. 检查访问权限

如果示例和文档服务器安装在不同的计算机上，请确保安装了示例的服务器可以访问您指定地址的文档服务器，而不是配置文件中的 documentserver。

确保文档服务器可以访问安装了示例的服务器，该示例的地址是您在配置文件中指定的地址，而不是 example.com。

步骤3. 配置 Ruby 示例

该示例是通过更改环境变量来配置的。

参数	描述	示例
BINDING	应启动服务器的地址	0.0.0.0
DOCUMENT_SERVER_PRIVATE_URL	服务器通过其与文档服务器进行通信的URL。	http://proxy:8080
DOCUMENT_SERVER_PUBLIC_URL	用户通过其与文档服务器进行通信的URL。	http://localhost:8080
EXAMPLE_URL	文档服务器通过其与服务器进行通信的URL。	http://proxy
JWT_SECRET	JWT授权密钥。保留为空可禁用授权。	your-256-bit-secret
PORT	服务器应运行的端口。	80

如果您成功集成了编辑器，结果应该类似于我们网站上的演示预览。