添加 llmdoc 文档系统,升级版本至 3.4.8-xg1
All checks were successful
Build and Release / build-and-test (arm64, alpine) (push) Successful in -11s
Build and Release / build-and-test (amd64, alpine) (push) Successful in -4s
Build and Release / build-and-test (arm64, ubuntu) (push) Successful in 1s
Build and Release / build-and-test (amd64, ubuntu) (push) Successful in 10s
Build and Release / release (push) Successful in 44s

- 初始化 llmdoc 文档系统(overview/architecture/guides/reference)
- 创建 9 个核心文档,涵盖项目概览、安装架构、配置系统等
- 升级 CI 工作流和构建脚本版本号至 3.4.8-xg1
- 添加 .gitignore 文件
This commit is contained in:
2025-12-25 09:06:01 +08:00
parent 7baadc74b1
commit 20935a6c89
12 changed files with 792 additions and 2 deletions

View File

@@ -0,0 +1,155 @@
# 如何使用 tar.gz 安装 XXXigCC
## 前提条件
- **支持的操作系统**Alpine Linux 或 Ubuntu/Debian
- **架构**x86_64 (amd64) 或 aarch64 (arm64)
- **必需工具**curl安装脚本会自动安装缺失的依赖
## 基本安装
### 1. 下载安装脚本
```bash
curl -O https://gitea.bcde.io/wangdefa/xxxigcc/raw/branch/main/script/install.sh
chmod +x install.sh
```
### 2. 运行安装
```bash
./install.sh -o pool.example.com:3333 -w YOUR_WALLET_ADDRESS
```
## 高级配置
### 常用参数
| 参数 | 说明 | 默认值 |
|------|------|--------|
| `-v, --version` | 版本号 | latest |
| `-t, --threads` | 线程数 | 自动 (CPU 核心数) |
| `-a, --algo` | 算法 | rx/0 |
| `-o, --pool` | 矿池地址 | **必需** |
| `-w, --wallet` | 钱包地址 | 自动生成 |
| `-p, --password` | 矿池密码 | 自动生成 |
| `--1gb-pages` | 启用 1GB 大页 | false |
| `--tls` | 启用 TLS | false |
| `--keepalive` | 启用 KeepAlive | false |
| `--daemon` | 启用 SOLO 挖矿 | false |
| `--nicehash` | 启用 NiceHash 模式 | true |
| `--verbose` | 启用详细输出 | true |
### 配置示例
#### 指定版本和线程数
```bash
./install.sh -v 3.4.6-xg1 -t 4 -o pool.example.com:3333 -w YOUR_WALLET
```
#### 启用高级功能
```bash
./install.sh -o pool.example.com:3333 -w YOUR_WALLET \
--1gb-pages \
--tls \
--keepalive
```
#### 启用 CC集中化管理
```bash
./install.sh -o pool.example.com:3333 -w YOUR_WALLET \
--cc \
--cc-url http://server:3344 \
--cc-token YOUR_TOKEN
```
## 安装路径
tar.gz 安装后的文件路径:
```
/etc/miner/xxxigcc/
├── config.json # 配置文件
├── xxxigDaemon # 守护进程
├── xxxigMiner # 挖矿程序
└── xxxigcc.log # 日志文件
```
## 服务管理
### Alpine Linux
```bash
# 查看状态
rc-service xxxigcc status
# 启动/停止/重启
rc-service xxxigcc start
rc-service xxxigcc stop
rc-service xxxigcc restart
# 查看日志
tail -f /etc/miner/xxxigcc/xxxigcc.log
```
### Ubuntu/Debian
```bash
# 查看状态
systemctl status xxxigcc
# 启动/停止/重启
systemctl start xxxigcc
systemctl stop xxxigcc
systemctl restart xxxigcc
# 查看日志
journalctl -u xxxigcc -f
```
## 升级版本
重新运行安装脚本,指定新版本:
```bash
./install.sh -v 3.4.7-xg1 -o pool.example.com:3333 -w YOUR_WALLET
```
## 卸载
使用卸载脚本:
```bash
curl -O https://gitea.bcde.io/wangdefa/xxxigcc/raw/branch/main/script/uninstall.sh
chmod +x uninstall.sh
sudo ./uninstall.sh
```
## 故障排查
### 检查服务状态
```bash
# Alpine
rc-service xxxigcc status
# Ubuntu/Debian
systemctl status xxxigcc
```
### 查看日志
```bash
# Alpine / tar.gz
tail -f /etc/miner/xxxigcc/xxxigcc.log
# Ubuntu/Debian
journalctl -u xxxigcc -f
```
### 手动测试
```bash
/etc/miner/xxxigcc/xxxigDaemon -c /etc/miner/xxxigcc/config.json
```
## 相关链接
- [卸载指南](../../script/README.md#卸载脚本)
- [配置参考](../reference/config-json-schema.md)
- [服务管理](../architecture/installation-architecture.md#服务管理)