PHP (Laravel) 示例

概述

这是一个使用 PHP 和 Laravel 框架编写的示例应用，集成了 ONLYOFFICE文档。

该示例应用仅用于测试和演示编辑器功能，请勿在未修改代码的情况下直接用于生产环境。如需启用测试示例，务必在上线前将其禁用。

重要安全信息

使用测试示例时，请注意以下安全事项：

• 因为无需授权，存储内容未受到未授权访问的保护。
• 参数由代码按固定脚本生成，链接中不执行参数替换检查。
• 测试示例仅用于响应 ONLYOFFICE 文档的请求，因此保存文件时未进行数据校验。
• 由于测试示例设计为与跨域的 ONLYOFFICE 文档交互，因此未限制来自其他站点的访问。

步骤 1. 配置环境

示例应用的根目录包含一个.env.example文件，其中定义了常用的环境变量。请将该文件内容复制到项目目录下的.env文件中。

您可以在此处找到完整的环境变量列表。

步骤 2. 安装必备组件并使用编辑器运行网站

PHP（Laravel）示例提供了多种安装选项，但我们强烈建议使用 Docker。

选项 1. 使用 Docker 安装

首先，您需要安装 Docker 桌面应用。 该应用已内置 Docker 配置文件，只需运行几条命令即可启动项目，您也可根据个人需求自行修改这些配置。

1. 下载并解压发布压缩包到以下目录：

cd /my/php-laravel/project
curl --output PHP.Laravel.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/PHP.Laravel.Example.zip
unzip PHP.Laravel.Example.zip
cd "PHP Laravel Example"

您应该修改.env文件中的DOCUMENT_SERVER_JWT_SECRET环境变量，因为docker-compose.yml使用它在 ONLYOFFICE 文档中设置 JWT 机密。

2. 要运行容器，可以使用make compose-start命令来构建并启动项目，也可以手动执行相应命令：

   • 构建并启动 Docker Compose：

     docker compose build && docker compose up -d

   • 安装依赖项：

     docker compose exec example composer install
       && docker compose exec node npm install
       && docker compose exec node npm run build

   • 为 Laravel 实例生成应用程序密钥：

     docker compose exec example php artisan key:generate

   要停止 Docker 容器，可以运行make compose-stop或docker compose down命令。

   如果安装和配置顺利完成，您现在可以通过访问localhost:80来试用示例应用程序。

   同时，您可以根据需要调整 nginx 配置和应用运行的端口。

选项 2. 本地安装

在开始使用示例前，请先安装 ONLYOFFICE 文档。有关在 Windows、Linux 或 Docker 上的安装方法，请参考详细指南。

1. 安装准备：

   • PHP >= 8.2
   • Node.js (16+) and NPM
   • Laravel (11) Server Requirements

2. 下载发布压缩包并解压至您选择的目录：

cd /path/to/my/projects
curl --output PHP.Laravel.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/PHP.Laravel.Example.zip
unzip PHP.Laravel.Example.zip
cd "PHP Laravel Example"

3. 运行 make install 或手动执行以下命令：

   • 安装 Composer 依赖项：

     composer install

   • 安装前端依赖项并构建应用资源：

     npm install && npm run build

   • 为 Laravel 实例生成应用程序密钥：

     php artisan key:generate

   如果安装和配置成功，您现在可以访问服务器地址来试用示例应用程序。

步骤 3. 配置 PHP（Laravel）示例

PHP（Laravel）示例是通过更改环境变量来配置的。

变量名称	描述	示例
USER	系统中的用户名。	user
UID	系统中的用户 ID 号 (UID)。	1000
DOCUMENT_STORAGE_PUBLIC_URL	客户端用于与服务器通信的 URL 地址。	http://localhost
DOCUMENT_STORAGE_PRIVATE_URL	ONLYOFFICE 文档用于与服务器通信的 URL 地址。	http://proxy
DOCUMENT_SERVER_PUBLIC_URL	客户端用于与 ONLYOFFICE 文档通信的 URL 地址。	http://localhost:8080
DOCUMENT_SERVER_PRIVATE_URL	服务器用于与 ONLYOFFICE 文档通信的 URL 地址。	http://proxy:8080
DOCUMENT_SERVER_JWT_SECRET	JWT 授权密钥。	your-256-bit-secret

步骤 4. 检查可访问性

如果示例和 ONLYOFFICE 文档安装在不同的计算机上，请确保示例服务器能通过配置文件中指定的地址访问 ONLYOFFICE 文档，而不是使用默认的 documentserver。

ONLYOFFICE 文档能通过配置文件中指定的地址访问示例服务器，而不是默认的 example.com。

故障排除

如果您在框架的安装或配置方面遇到问题，请查看 Laravel 文档页面。