跳到主要内容

Python 示例

概述​

本示例将帮助您把ONLYOFFICE文档集成到用PHP编写的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 Python.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Python.Example.zip
unzip Python.Example.zip

然后打开示例目录并启动容器:

cd "Python Example"
make compose-prod

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

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

选项2.在本地计算机上​

下载并安装ONLYOFFICE文档（打包为文档服务器）：

获取ONLYOFFICE文档

查看详细指南，了解如何在Windows，Linux，和Docker上安装它。

要在您的本地计算机上运行示例，您将需要Python 3.11.4和pip 23.1.2。另外，您可能需要考虑安装GNU Make4.4.1，不过这是可选的。这些是工具所需的最低版本。

安装好所有内容后，下载发行版压缩包并解压：

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

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

cd "Python Example"
make prod
make server-prod

默认情况下，服务器在0.0.0.0:9000启动。

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

步骤2.检查可访问性​

如果示例和ONLYOFFICE文档安装在不同的计算机上，请确保安装了示例的服务器能够访问您在配置文件中指定的（替换了documentserver的）地址的ONLYOFFICE文档。

同时确保ONLYOFFICE文档反过来也能够访问安装了示例的服务器，使用您在配置文件中指定的（替换了example.com的）地址。

步骤3.配置Python示例​

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

参数示例描述
DEBUGfalse禁用或启用调试模式。
ADDRESS0.0.0.0服务器应启动的地址。
PORT80服务器应运行的端口。
DOCUMENT_SERVER_PRIVATE_URLhttp://proxy:8080服务器将通过其与 ONLYOFFICE 文档通信的 URL。
DOCUMENT_SERVER_PUBLIC_URLhttp://localhost:8080用户将通过其与 ONLYOFFICE 文档通信的 URL。
EXAMPLE_URLhttp://proxyONLYOFFICE 文档将通过其与服务器通信的 URL。
JWT_SECRETyour-256-bit-secretJWT 授权密钥。留空以禁用授权。