From 6342591821aad389ee3c573289b7a4a8c66faa84 Mon Sep 17 00:00:00 2001 From: xboard Date: Thu, 16 Jan 2025 22:34:57 +0800 Subject: [PATCH] update docs --- docs/zh-CN/installation/aapanel-docker.md | 1 + docs/zh-CN/installation/aapanel.md | 148 ++++++++++++++-------- 2 files changed, 93 insertions(+), 56 deletions(-) diff --git a/docs/zh-CN/installation/aapanel-docker.md b/docs/zh-CN/installation/aapanel-docker.md index 4cf9748..a2f751f 100644 --- a/docs/zh-CN/installation/aapanel-docker.md +++ b/docs/zh-CN/installation/aapanel-docker.md @@ -114,6 +114,7 @@ docker compose up -d ``` > - 如果您是较早安装的旧版本,需要将命令中的 `web` 改为 `xboard`,即: ```bash +git fetch --all && git reset --hard origin/master && git pull origin master docker compose pull && \ docker compose run -it --rm xboard php artisan xboard:update && \ docker compose up -d diff --git a/docs/zh-CN/installation/aapanel.md b/docs/zh-CN/installation/aapanel.md index d05534a..6aa917c 100644 --- a/docs/zh-CN/installation/aapanel.md +++ b/docs/zh-CN/installation/aapanel.md @@ -1,47 +1,69 @@ -## aaPanel 快速部署指南 +## Xboard 在 aaPanel 环境下的部署指南 -本指南介绍如何使用 aaPanel 部署 Xboard。 +## 目录 +1. [环境要求](#环境要求) +2. [快速部署](#快速部署) +3. [详细配置](#详细配置) +4. [维护指南](#维护指南) +5. [故障排查](#故障排查) -⚠️ 不建议在 CentOS 7 上部署,可能会遇到兼容性问题。 +## 环境要求 -### 1. 环境准备 +### 硬件配置 +- CPU: 1核心及以上 +- 内存: 2GB及以上 +- 硬盘: 10GB及以上可用空间 -安装 aaPanel: +### 软件要求 +- 操作系统: Ubuntu 20.04+ / Debian 10+ (⚠️ 不建议使用 CentOS 7) +- aaPanel 最新版 +- PHP 8.2 +- MySQL 5.7+ +- Redis +- Nginx(任意版本) + +## 快速部署 + +### 1. 安装 aaPanel ```bash URL=https://www.aapanel.com/script/install_6.0_en.sh && \ if [ -f /usr/bin/curl ];then curl -ksSO "$URL" ;else wget --no-check-certificate -O install_6.0_en.sh "$URL";fi && \ bash install_6.0_en.sh aapanel ``` -### 2. 环境配置 +### 2. 基础环境配置 -1. 在 aaPanel 中安装 LNMP: - - Nginx(任意版本) - - MySQL 5.7 - - PHP 8.2 +#### 2.1 安装 LNMP 环境 +在 aaPanel 面板中安装: +- Nginx(任意版本) +- MySQL 5.7 +- PHP 8.2 -2. 安装 PHP 扩展: - - redis - - fileinfo - - swoole4 - - readline - - event +#### 2.2 安装 PHP 扩展 +必需的 PHP 扩展: +- redis +- fileinfo +- swoole4 +- readline +- event -3. 解除 PHP 禁用函数: - - putenv - - proc_open - - pcntl_alarm - - pcntl_signal +#### 2.3 解除 PHP 禁用函数 +需要启用的函数: +- putenv +- proc_open +- pcntl_alarm +- pcntl_signal -### 3. 部署步骤 +### 3. 站点配置 -1. 添加站点: - - 进入 aaPanel > Website > Add site - - 填写域名 - - 数据库选择 MySQL - - PHP 版本选择 8.1 +#### 3.1 创建站点 +1. 导航至:aaPanel > Website > Add site +2. 填写信息: + - 域名:填写您的站点域名 + - 数据库:选择 MySQL + - PHP 版本:选择 8.2 -2. 安装 Xboard: +#### 3.2 部署 Xboard ```bash # 进入站点目录 cd /www/wwwroot/你的域名 @@ -57,9 +79,9 @@ git clone https://github.com/cedar2025/Xboard.git ./ sh init.sh ``` -3. 配置站点: - - 设置运行目录为 `/public` - - 配置伪静态规则: +#### 3.3 配置站点 +1. 设置运行目录为 `/public` +2. 添加伪静态规则: ```nginx location /downloads { } @@ -76,30 +98,32 @@ location ~ .*\.(js|css)?$ } ``` -4. 配置守护进程: - - 安装 Supervisor - - 添加队列守护进程: - - 名称:`Xboard` - - 运行用户:`www` - - 运行目录:站点目录 - - 启动命令:`php artisan horizon` - - 进程数:1 +## 详细配置 -5. 添加计划任务: - - 类型:Shell Script - - 任务名:v2board - - 周期:1分钟 - - 脚本内容:`php /www/wwwroot/站点目录/artisan schedule:run` - -### 4. 开启 Octane(可选) -1. 添加 Octane 守护进程: - - 名称:Octane - - 运行用户:www +### 1. 配置守护进程 +1. 安装 Supervisor +2. 添加队列守护进程: + - 名称:`Xboard` + - 运行用户:`www` - 运行目录:站点目录 - - 启动命令:`/www/server/php/81/bin/php artisan octane:start --port 7010` + - 启动命令:`php artisan horizon` - 进程数:1 -2. 更新伪静态规则: +### 2. 配置计划任务 +- 类型:Shell Script +- 任务名:v2board +- 周期:1分钟 +- 脚本内容:`php /www/wwwroot/站点目录/artisan schedule:run` + +### 3. Octane 配置(可选) +#### 3.1 添加 Octane 守护进程 +- 名称:Octane +- 运行用户:www +- 运行目录:站点目录 +- 启动命令:`/www/server/php/81/bin/php artisan octane:start --port 7010` +- 进程数:1 + +#### 3.2 Octane 专用伪静态规则 ```nginx location ~* \.(jpg|jpeg|png|gif|js|css|svg|woff2|woff|ttf|eot|wasm|json|ico)$ { } @@ -120,18 +144,30 @@ location ~ .* { } ``` -### 5. 版本更新 +## 维护指南 +### 版本更新 ```bash -# 更新代码 +# 进入站点目录 cd /www/wwwroot/你的域名 + +# 执行更新脚本 +git fetch --all && git reset --hard origin/master && git pull origin master sh update.sh # 如果启用了 Octane,需要重启守护进程 # aaPanel > App Store > Tools > Supervisor > 重启 Octane ``` -### 注意事项 +### 日常维护 +- 定期检查日志 +- 监控系统资源使用情况 +- 定期备份数据库和配置文件 -- 修改后台路径需要重启服务才能生效 -- 启用 octane 后的任何代码修改都需要重启才能生效 +## 故障排查 + +### 常见问题 +1. 修改后台路径需要重启服务才能生效 +2. 启用 Octane 后的任何代码修改都需要重启才能生效 +3. PHP 扩展安装失败时,请检查 PHP 版本是否正确 +4. 数据库连接失败时,请检查数据库配置和权限