翻译文档

This commit is contained in:
yinjianm
2026-02-22 04:13:42 +08:00
parent 267aeec5ba
commit 2d14e22322
13 changed files with 683 additions and 687 deletions
+61 -61
View File
@@ -1,88 +1,88 @@
# Xboard Deployment Guide for aaPanel + Docker Environment
# aaPanel + Docker 环境下的 Xboard 部署指南
## Table of Contents
1. [Requirements](#requirements)
2. [Quick Deployment](#quick-deployment)
3. [Detailed Configuration](#detailed-configuration)
4. [Maintenance Guide](#maintenance-guide)
5. [Troubleshooting](#troubleshooting)
## 目录
1. [环境要求](#环境要求)
2. [快速部署](#快速部署)
3. [详细配置](#详细配置)
4. [维护指南](#维护指南)
5. [故障排查](#故障排查)
## Requirements
## 环境要求
### Hardware Requirements
- CPU: 1 core or above
- Memory: 2GB or above
- Storage: 10GB+ available space
### 硬件要求
- CPU1 核及以上
- 内存:2GB 及以上
- 存储:可用空间 10GB+
### Software Requirements
- Operating System: Ubuntu 20.04+ / CentOS 7+ / Debian 10+
- Latest version of aaPanel
- Docker and Docker Compose
- Nginx (any version)
### 软件要求
- 操作系统:Ubuntu 20.04+ / CentOS 7+ / Debian 10+
- aaPanel 最新版本
- Docker Docker Compose
- Nginx(任意版本)
- MySQL 5.7+
## Quick Deployment
## 快速部署
### 1. Install aaPanel
### 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. Basic Environment Setup
### 2. 基础环境配置
#### 2.1 Install Docker
#### 2.1 安装 Docker
```bash
# Install Docker
# 安装 Docker
curl -sSL https://get.docker.com | bash
# For CentOS systems, also run:
# CentOS 系统还需要执行:
systemctl enable docker
systemctl start docker
```
#### 2.2 Install Required Components
In the aaPanel dashboard, install:
- Nginx (any version)
#### 2.2 安装必需组件
aaPanel 面板中安装:
- Nginx(任意版本)
- MySQL 5.7
- ⚠️ PHP and Redis are not required
- PHP Redis 不需要安装
### 3. Site Configuration
### 3. 网站配置
#### 3.1 Create Website
1. Navigate to: aaPanel > Website > Add site
2. Fill in the information:
- Domain: Enter your site domain
- Database: Select MySQL
- PHP Version: Select Pure Static
#### 3.1 创建网站
1. 进入:aaPanel > 网站 > 添加站点
2. 填写信息:
- 域名:填写你的网站域名
- 数据库:选择 MySQL
- PHP 版本:选择纯静态
#### 3.2 Deploy Xboard
#### 3.2 部署 Xboard
```bash
# Enter site directory
# 进入网站目录
cd /www/wwwroot/your-domain
# Clean directory
# 清理目录
chattr -i .user.ini
rm -rf .htaccess 404.html 502.html index.html .user.ini
# Clone repository
# 克隆仓库
git clone https://github.com/Micah123321/Xboard.git ./
# Prepare configuration file
# 准备配置文件
cp compose.sample.yaml compose.yaml
# Install dependencies and initialize
# 安装依赖并初始化
docker compose run -it --rm web sh init.sh
```
> ⚠️ Please save the admin dashboard URL, username, and password shown after installation
> 请保存安装完成后显示的管理后台地址、用户名和密码
#### 3.3 Start Services
#### 3.3 启动服务
```bash
docker compose up -d
```
#### 3.4 Configure Reverse Proxy
Add the following content to your site configuration:
#### 3.4 配置反向代理
将以下内容添加到网站配置:
```nginx
location ^~ / {
proxy_pass http://127.0.0.1:7001;
@@ -101,18 +101,18 @@ location ^~ / {
}
```
## Maintenance Guide
## 维护指南
### Version Updates
### 版本更新
> 💡 Important Note: Update commands may vary depending on your installed version:
> - For recent installations (new version), use:
> 重要说明:更新命令会因你安装的版本不同而有所区别:
> - 如果是最近安装(新版本),使用:
```bash
docker compose pull && \
docker compose run -it --rm web sh update.sh && \
docker compose up -d
```
> - For older installations, replace `web` with `xboard`:
> - 如果是较早安装(旧版本),请把 `web` 替换为 `xboard`
```bash
git config --global --add safe.directory $(pwd)
git fetch --all && git reset --hard origin/master && git pull origin master
@@ -120,18 +120,18 @@ docker compose pull && \
docker compose run -it --rm xboard sh update.sh && \
docker compose up -d
```
> 🤔 Not sure which to use? Try the new version command first, if it fails, use the old version command.
> 不确定该用哪个命令?先尝试新版本命令,失败后再使用旧版本命令。
### Routine Maintenance
- Regular log checking: `docker compose logs`
- Monitor system resource usage
- Regular backup of database and configuration files
### 日常维护
- 定期查看日志:`docker compose logs`
- 监控系统资源使用情况
- 定期备份数据库和配置文件
## Troubleshooting
## 故障排查
If you encounter any issues during installation or operation, please check:
1. System requirements are met
2. All required ports are available
3. Docker services are running properly
4. Nginx configuration is correct
5. Check logs for detailed error messages
如果在安装或运行中遇到问题,请检查:
1. 系统要求是否满足
2. 所有必需端口是否可用
3. Docker 服务是否正常运行
4. Nginx 配置是否正确
5. 查看日志以获取详细报错信息