此示例将帮助您将 ONLYOFFICE 文档集成到用 Python 编写的 Web 应用程序中。
在使用测试示例时,请记住以下几方面的安全事项:
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 Docs。 查看详细指南,了解如何在Windows, Linux, 或 Docker上安装它。
要在本地计算机上运行该示例,您需要 Python 3.11.4 与 pip 23.1.2。此外,您可能需要考虑安装 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 prod make server-prod
默认情况下,服务器从0.0.0.0:8000启动。
要配置该示例,您可以在启动服务器的命令之前传递环境变量。 有关环境变量的更多信息,请参阅下面。
如果示例和文档服务器安装在不同的计算机上,请确保安装了示例的服务器可以访问您指定地址的文档服务器,而不是配置文件中的 documentserver。
确保文档服务器可以访问安装了示例的服务器,该示例的地址是您在配置文件中指定的地址,而不是 example.com。
该示例是通过更改环境变量来配置的。
参数 | 描述 | 示例 |
DEBUG | 禁用或启用调试模式 | false |
ADDRESS | 应启动服务器的地址 | 0.0.0.0 |
PORT | 服务器应运行的端口 | 80 |
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 |
如果您成功集成了编辑器,结果应该类似于我们网站上的演示预览。