feat: new xboard

2025-01-21 14:57:54 +08:00
parent de18cfe596
commit 0f43fff242
373 changed files with 17923 additions and 20264 deletions
@@ -0,0 +1,222 @@
+# Xboard 在 1Panel 环境下的部署指南
+
+## 目录
+1. [环境要求](#环境要求)
+2. [快速部署](#快速部署)
+3. [详细配置](#详细配置)
+4. [维护指南](#维护指南)
+5. [故障排查](#故障排查)
+
+## 环境要求
+
+### 硬件配置
+- CPU: 1核心及以上
+- 内存: 2GB及以上
+- 硬盘: 10GB及以上可用空间
+
+### 软件要求
+- 操作系统: Ubuntu 20.04+ / CentOS 7+ / Debian 10+
+- 1Panel 最新版
+- Docker 和 Docker Compose
+
+## 快速部署
+
+### 1. 安装 1Panel
+```bash
+curl -sSL https://resource.fit2cloud.com/1panel/package/quick_start.sh -o quick_start.sh && \
+sudo bash quick_start.sh
+```
+
+### 2. 基础环境配置
+
+#### 2.1 安装必要组件
+在 1Panel 应用商店中安装：
+- OpenResty
+  - ✅ 勾选"端口外部访问"选项
+  - 📝 记录安装路径
+- MySQL 5.7
+  > ARM 架构设备推荐使用 MariaDB 替代
+
+#### 2.2 创建数据库
+1. 数据库配置：
+   - 名称: `xboard`
+   - 用户: `xboard`
+   - 访问权限: 所有主机(%)
+   - 🔐 请安全保存数据库密码
+
+### 3. 站点配置
+
+#### 3.1 创建站点
+1. 导航至：网站 > 创建网站 > 反向代理
+2. 填写信息：
+   - 域名: 您的站点域名
+   - 代号: `xboard`
+   - 代理地址: `127.0.0.1:7001`
+
+#### 3.2 配置反向代理
+在站点配置中添加以下内容：
+```nginx
+location ^~ / {
+    proxy_pass http://127.0.0.1:7001;
+    proxy_http_version 1.1;
+    proxy_set_header Connection "";
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Real-PORT $remote_port;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_set_header Scheme $scheme;
+    proxy_set_header Server-Protocol $server_protocol;
+    proxy_set_header Server-Name $server_name;
+    proxy_set_header Server-Addr $server_addr;
+    proxy_set_header Server-Port $server_port;
+    proxy_cache off;
+}
+```
+
+### 4. 部署 Xboard
+
+#### 4.1 获取源码
+```bash
+# 进入站点目录
+cd /opt/1panel/apps/openresty/openresty/www/sites/xboard/index
+
+# 安装 Git（如需要）
+## Ubuntu/Debian
+apt update && apt install -y git
+## CentOS/RHEL
+yum update && yum install -y git
+
+# 克隆项目
+git clone -b compose --depth 1 https://github.com/cedar2025/Xboard ./
+```
+
+#### 4.2 配置 Docker Compose
+创建或修改 `docker-compose.yml`:
+```yaml
+services:
+  web:
+    image: ghcr.io/cedar2025/xboard:latest
+    volumes:
+      - ./.docker/.data/redis/:/data/
+      - ./.env:/www/.env
+      - ./.docker/.data/:/www/.docker/.data
+      - ./storage/logs:/www/storage/logs
+      - ./storage/theme:/www/storage/theme
+    environment:
+      - docker=true
+    depends_on:
+      - redis
+    command: php artisan octane:start --host=0.0.0.0 --port=7001
+    restart: on-failure
+    ports:
+      - 7001:7001
+    networks:
+      - 1panel-network
+
+  horizon:
+    image: ghcr.io/cedar2025/xboard:latest
+    volumes:
+      - ./.docker/.data/redis/:/data/
+      - ./.env:/www/.env
+      - ./.docker/.data/:/www/.docker/.data
+      - ./storage/logs:/www/storage/logs
+    restart: on-failure
+    command: php artisan horizon
+    networks:
+      - 1panel-network
+    depends_on:
+      - redis
+
+  redis:
+    image: redis:7-alpine
+    command: redis-server --unixsocket /data/redis.sock --unixsocketperm 777 --save 900 1 --save 300 10 --save 60 10000
+    restart: unless-stopped
+    networks:
+      - 1panel-network
+    volumes:
+      - ./.docker/.data/redis:/data
+
+networks:
+  1panel-network:
+    external: true
+
+```
+
+#### 4.3 初始化安装
+```bash
+# 安装并初始化
+docker compose run -it --rm web php artisan xboard:install
+```
+
+⚠️ 重要配置说明：
+1. 数据库配置
+   - 数据库地址：根据部署方式选择以下配置
+     1. 如果数据库和 Xboard 在同一网络，一般填写 `mysql`
+     2. 如果连接失败，请在 1Panel 面板中依次打开：数据库 -> 选择对应数据库 -> 连接信息 -> 容器连接，使用其中的"地址"
+     3. 如果使用外部数据库，填写实际的数据库地址
+   - 数据库端口：`3306`（如无特殊配置，使用默认端口）
+   - 数据库名称：`xboard`（之前创建的数据库名）
+   - 数据库用户：`xboard`（之前创建的用户名）
+   - 数据库密码：填写之前保存的密码
+
+2. Redis 配置
+   - 选择使用内置 Redis
+   - 无需额外配置
+
+3. 管理员信息
+   - 请妥善保存安装完成后返回的管理员账号和密码
+   - 记录后台访问地址
+
+完成配置后启动服务：
+```bash
+docker compose up -d
+```
+
+## 维护指南
+
+### 版本更新
+
+> 💡 重要提示：根据您安装的版本不同，更新命令可能略有差异：
+> - 如果您是最近安装的新版本，使用下面的命令：
+```bash
+docker compose pull && \
+docker compose run -it --rm web php artisan xboard:update && \
+docker compose up -d
+```
+> - 如果您是较早安装的旧版本，需要将命令中的 `web` 改为 `xboard`，即：
+```bash
+docker compose pull && \
+docker compose run -it --rm xboard php artisan xboard:update && \
+docker compose up -d
+```
+> 🤔 不确定用哪个？可以先尝试使用新版命令，如果报错再使用旧版命令。
+
+### 日常维护
+- 定期检查日志: `docker compose logs`
+- 监控系统资源使用情况
+- 定期备份数据库和配置文件
+
+## 故障排查
+
+### 常见问题
+1. 无法访问网站
+   - 检查防火墙配置
+   - 验证端口是否正确开放
+   - 检查 Docker 容器状态
+
+2. 数据库连接失败
+   - 验证数据库凭据
+   - 检查数据库服务状态
+   - 确认网络连接
+
+### 安全建议
+- ⚠️ 确保 7001 端口不对外开放
+- 定期更新系统和组件
+- 配置 SSL 证书实现 HTTPS 访问
+- 使用强密码策略
+- 定期备份数据
+
+### 获取帮助
+- 查看官方文档
+- 访问项目 GitHub 仓库
+- 加入社区讨论组
@@ -0,0 +1,130 @@
+# Xboard 在 aaPanel + Docker 环境下的部署指南
+
+## 目录
+1. [环境要求](#环境要求)
+2. [快速部署](#快速部署)
+3. [详细配置](#详细配置)
+4. [维护指南](#维护指南)
+5. [故障排查](#故障排查)
+
+## 环境要求
+
+### 硬件配置
+- CPU: 1核心及以上
+- 内存: 2GB及以上
+- 硬盘: 10GB及以上可用空间
+
+### 软件要求
+- 操作系统: Ubuntu 20.04+ / CentOS 7+ / Debian 10+
+- aaPanel 最新版
+- Docker 和 Docker Compose
+- Nginx（任意版本）
+- MySQL 5.7+
+
+## 快速部署
+
+### 1. 安装 aaPanel
+```bash
+curl -sSL https://www.aapanel.com/script/install_6.0_en.sh -o install_6.0_en.sh && \
+bash install_6.0_en.sh aapanel
+```
+
+### 2. 基础环境配置
+
+#### 2.1 安装 Docker
+```bash
+# 安装 Docker
+curl -sSL https://get.docker.com | bash
+
+# CentOS 系统需要执行：
+systemctl enable docker
+systemctl start docker
+```
+
+#### 2.2 安装必要组件
+在 aaPanel 面板中安装：
+- Nginx（任意版本）
+- MySQL 5.7
+- ⚠️ 无需安装 PHP 和 Redis
+
+### 3. 站点配置
+
+#### 3.1 创建站点
+1. 导航至：aaPanel > Website > Add site
+2. 填写信息：
+   - 域名：填写您的站点域名
+   - 数据库：选择 MySQL
+   - PHP 版本：选择纯静态
+
+#### 3.2 部署 Xboard
+```bash
+# 进入站点目录
+cd /www/wwwroot/你的域名
+
+# 清理目录
+chattr -i .user.ini
+rm -rf .htaccess 404.html 502.html index.html .user.ini
+
+# 克隆代码
+git clone https://github.com/cedar2025/Xboard.git ./
+
+# 准备配置文件
+cp compose.sample.yaml compose.yaml
+
+# 安装依赖并初始化
+docker compose run -it --rm web sh init.sh
+```
+> ⚠️ 请妥善保存安装完成后返回的后台地址和管理员账号密码
+
+#### 3.3 启动服务
+```bash
+docker compose up -d
+```
+
+#### 3.4 配置反向代理
+在站点配置中添加以下内容：
+```nginx
+location / {
+    proxy_pass http://127.0.0.1:7001;
+    proxy_http_version 1.1;
+    proxy_set_header Connection "";
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Real-PORT $remote_port;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_set_header Scheme $scheme;
+    proxy_set_header Server-Protocol $server_protocol;
+    proxy_set_header Server-Name $server_name;
+    proxy_set_header Server-Addr $server_addr;
+    proxy_set_header Server-Port $server_port;
+    proxy_cache off;
+}
+```
+
+## 维护指南
+
+### 版本更新
+
+> 💡 重要提示：根据您安装的版本不同，更新命令可能略有差异：
+> - 如果您是最近安装的新版本，使用下面的命令：
+```bash
+docker compose pull && \
+docker compose run -it --rm web sh update.sh && \
+docker compose up -d
+```
+> - 如果您是较早安装的旧版本，需要将命令中的 `web` 改为 `xboard`，即：
+```bash
+git config --global --add safe.directory $(pwd)
+git fetch --all && git reset --hard origin/master && git pull origin master
+docker compose pull && \
+docker compose run -it --rm xboard sh update.sh && \
+docker compose up -d
+```
+> 🤔 不确定用哪个？可以先尝试使用新版命令，如果报错再使用旧版命令。
+
+### 日常维护
+- 定期检查日志: `docker compose logs`
+- 监控系统资源使用情况
+- 定期备份数据库和配置文件
+
+## 故障排查
@@ -0,0 +1,173 @@
+## Xboard 在 aaPanel 环境下的部署指南
+
+## 目录
+1. [环境要求](#环境要求)
+2. [快速部署](#快速部署)
+3. [详细配置](#详细配置)
+4. [维护指南](#维护指南)
+5. [故障排查](#故障排查)
+
+## 环境要求
+
+### 硬件配置
+- CPU: 1核心及以上
+- 内存: 2GB及以上
+- 硬盘: 10GB及以上可用空间
+
+### 软件要求
+- 操作系统: 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 安装 LNMP 环境
+在 aaPanel 面板中安装：
+- Nginx（任意版本）
+- MySQL 5.7
+- PHP 8.2
+
+#### 2.2 安装 PHP 扩展
+必需的 PHP 扩展：
+- redis
+- fileinfo
+- swoole4
+- readline
+- event
+
+#### 2.3 解除 PHP 禁用函数
+需要启用的函数：
+- putenv
+- proc_open
+- pcntl_alarm
+- pcntl_signal
+
+### 3. 站点配置
+
+#### 3.1 创建站点
+1. 导航至：aaPanel > Website > Add site
+2. 填写信息：
+   - 域名：填写您的站点域名
+   - 数据库：选择 MySQL
+   - PHP 版本：选择 8.2
+
+#### 3.2 部署 Xboard
+```bash
+# 进入站点目录
+cd /www/wwwroot/你的域名
+
+# 清理目录
+chattr -i .user.ini
+rm -rf .htaccess 404.html 502.html index.html .user.ini
+
+# 克隆代码
+git clone https://github.com/cedar2025/Xboard.git ./
+
+# 安装依赖
+sh init.sh
+```
+
+#### 3.3 配置站点
+1. 设置运行目录为 `/public`
+2. 添加伪静态规则：
+```nginx
+location /downloads {
+}
+
+location / {  
+    try_files $uri $uri/ /index.php$is_args$query_string;  
+}
+
+location ~ .*\.(js|css)?$
+{
+    expires      1h;
+    error_log off;
+    access_log /dev/null; 
+}
+```
+
+## 详细配置
+
+### 1. 配置守护进程
+1. 安装 Supervisor
+2. 添加队列守护进程：
+   - 名称：`Xboard`
+   - 运行用户：`www`
+   - 运行目录：站点目录
+   - 启动命令：`php artisan horizon`
+   - 进程数：1
+
+### 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)$ {
+}
+
+location ~ .* {
+    proxy_pass http://127.0.0.1:7010;
+    proxy_http_version 1.1;
+    proxy_set_header Connection "";
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Real-PORT $remote_port;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_set_header Scheme $scheme;
+    proxy_set_header Server-Protocol $server_protocol;
+    proxy_set_header Server-Name $server_name;
+    proxy_set_header Server-Addr $server_addr;
+    proxy_set_header Server-Port $server_port;
+}
+```
+
+## 维护指南
+
+### 版本更新
+```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
+```
+
+### 日常维护
+- 定期检查日志
+- 监控系统资源使用情况
+- 定期备份数据库和配置文件
+
+## 故障排查
+
+### 常见问题
+1. 修改后台路径需要重启服务才能生效
+2. 启用 Octane 后的任何代码修改都需要重启才能生效
+3. PHP 扩展安装失败时，请检查 PHP 版本是否正确
+4. 数据库连接失败时，请检查数据库配置和权限
@@ -0,0 +1,77 @@
+## Docker Compose 快速部署指南
+
+本指南介绍如何使用 Docker Compose 快速部署 Xboard。默认使用 SQLite 数据库，无需额外安装 MySQL。
+
+### 1. 环境准备
+
+安装 Docker:
+```bash
+curl -sSL https://get.docker.com | bash
+
+# CentOS 系统需要执行：
+systemctl enable docker
+systemctl start docker
+```
+
+### 2. 部署步骤
+
+1. 获取项目文件：
+```bash
+git clone -b compose --depth 1 https://github.com/cedar2025/Xboard
+cd Xboard
+```
+
+2. 安装数据库：  
+
+- 快速安装（推荐新手使用）
+```bash
+docker compose run -it --rm \
+    -e ENABLE_SQLITE=true \
+    -e ENABLE_REDIS=true \
+    -e ADMIN_ACCOUNT=admin@demo.com \
+    web php artisan xboard:install
+```
+- 自定义配置安装（高级用户）
+```bash
+docker compose run -it --rm web php artisan xboard:install
+```
+> 安装完成后请保存返回的后台地址和管理员账号密码
+
+3. 启动服务：
+```bash
+docker compose up -d
+```
+
+4. 访问站点：
+- 默认端口：7001
+- 网站地址：http://服务器IP:7001
+
+### 3. 版本更新
+
+> 💡 重要提示：根据您安装的版本不同，更新命令可能略有差异：
+> - 如果您是最近安装的新版本，使用下面的命令：
+```bash
+cd Xboard
+docker compose pull && \
+docker compose run -it --rm web php artisan xboard:update && \
+docker compose up -d
+```
+> - 如果您是较早安装的旧版本，需要将命令中的 `web` 改为 `xboard`，即：
+```bash
+cd Xboard
+docker compose pull && \
+docker compose run -it --rm xboard php artisan xboard:update && \
+docker compose up -d
+```
+> 🤔 不确定用哪个？可以先尝试使用新版命令，如果报错再使用旧版命令。
+
+### 4. 版本回滚
+
+1. 修改 `docker-compose.yaml` 中的版本号为需要回滚的版本
+2. 执行：`docker compose up -d`
+
+### 注意事项
+
+- 如需使用 MySQL，请自行安装并重新部署
+- 代码修改后需要重启服务才能生效
+- 可以配置 Nginx 反向代理使用 80 端口