添加 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
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:
226
llmdoc/guides/how-to-configure-miner.md
Normal file
226
llmdoc/guides/how-to-configure-miner.md
Normal file
@@ -0,0 +1,226 @@
|
||||
# 如何配置挖矿节点
|
||||
|
||||
本指南说明如何配置 XXXigCC 挖矿节点(Daemon/Miner)。
|
||||
|
||||
## 配置文件位置
|
||||
|
||||
根据安装方式不同,配置文件位置如下:
|
||||
|
||||
- **tar.gz 安装**:`/etc/miner/xxxigcc/config.json`
|
||||
- **DEB 包安装**:`/etc/xxxigcc/config.json`
|
||||
- **手动部署**:当前目录下的 `config.json`
|
||||
|
||||
## 基本配置
|
||||
|
||||
### 1. 矿池配置
|
||||
|
||||
最基本的配置是设置矿池信息:
|
||||
|
||||
```json
|
||||
{
|
||||
"pools": [
|
||||
{
|
||||
"url": "pool.example.com:3333",
|
||||
"user": "YOUR_WALLET_ADDRESS",
|
||||
"pass": "x",
|
||||
"tls": false,
|
||||
"keepalive": true,
|
||||
"nicehash": true
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**参数说明:**
|
||||
- `url`:矿池地址和端口
|
||||
- `user`:钱包地址
|
||||
- `pass`:矿池密码(通常为 "x")
|
||||
- `tls`:是否启用 TLS 加密连接
|
||||
- `keepalive`:保持连接活跃
|
||||
- `nicehash`:NiceHash 兼容模式
|
||||
|
||||
### 2. 算法选择
|
||||
|
||||
```json
|
||||
{
|
||||
"algo": "rx/0",
|
||||
"pools": [...]
|
||||
}
|
||||
```
|
||||
|
||||
常用算法:
|
||||
- `rx/0`:RandomX(Monero)
|
||||
- `cn/0`:CryptoNight
|
||||
|
||||
### 3. CPU 配置
|
||||
|
||||
#### 自动配置(推荐)
|
||||
```json
|
||||
{
|
||||
"autosave": true,
|
||||
"cpu": true
|
||||
}
|
||||
```
|
||||
|
||||
#### 手动配置线程数
|
||||
```json
|
||||
{
|
||||
"cpu": {
|
||||
"enabled": true,
|
||||
"max-threads-hint": 4
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 高级 CPU 配置
|
||||
```json
|
||||
{
|
||||
"cpu": {
|
||||
"enabled": true,
|
||||
"max-threads-hint": 75,
|
||||
"rx": [0, 1, 2, 3]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4. 日志配置
|
||||
|
||||
```json
|
||||
{
|
||||
"log-file": "/var/log/xxxigcc/xxxigcc.log",
|
||||
"verbose": true
|
||||
}
|
||||
```
|
||||
|
||||
## 高级配置
|
||||
|
||||
### 1. 大页内存(1GB Pages)
|
||||
|
||||
提高挖矿性能:
|
||||
|
||||
```json
|
||||
{
|
||||
"randomx": {
|
||||
"1gb-pages": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**启用前需要设置系统:**
|
||||
```bash
|
||||
sudo sysctl -w vm.nr_hugepages=3
|
||||
```
|
||||
|
||||
### 2. SOLO 挖矿模式
|
||||
|
||||
```json
|
||||
{
|
||||
"pools": [
|
||||
{
|
||||
"url": "127.0.0.1:18081",
|
||||
"daemon": true,
|
||||
"self-select": "solo.example.com:3333"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 集中化管理(CC)配置
|
||||
|
||||
连接到 CC 服务器:
|
||||
|
||||
```json
|
||||
{
|
||||
"cc-client": {
|
||||
"enabled": true,
|
||||
"servers": [
|
||||
{
|
||||
"url": "http://server-ip:3344",
|
||||
"access-token": "YOUR_ACCESS_TOKEN",
|
||||
"use-tls": false,
|
||||
"worker-id": "worker-01"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4. 捐赠设置
|
||||
|
||||
XXXigCC 默认捐赠级别为 0:
|
||||
|
||||
```json
|
||||
{
|
||||
"donate-level": 0,
|
||||
"donate-over-proxy": 0
|
||||
}
|
||||
```
|
||||
|
||||
## 完整配置示例
|
||||
|
||||
```json
|
||||
{
|
||||
"autosave": true,
|
||||
"cpu": true,
|
||||
"opencl": false,
|
||||
"cuda": false,
|
||||
"log-file": "/var/log/xxxigcc/xxxigcc.log",
|
||||
"verbose": true,
|
||||
"algo": "rx/0",
|
||||
"pools": [
|
||||
{
|
||||
"url": "pool.example.com:3333",
|
||||
"user": "YOUR_WALLET_ADDRESS",
|
||||
"pass": "x",
|
||||
"tls": false,
|
||||
"keepalive": true,
|
||||
"nicehash": true
|
||||
}
|
||||
],
|
||||
"randomx": {
|
||||
"1gb-pages": false
|
||||
},
|
||||
"cc-client": {
|
||||
"enabled": false
|
||||
},
|
||||
"donate-level": 0
|
||||
}
|
||||
```
|
||||
|
||||
## 应用配置
|
||||
|
||||
修改配置后需要重启服务:
|
||||
|
||||
### Alpine Linux
|
||||
```bash
|
||||
rc-service xxxigcc restart
|
||||
```
|
||||
|
||||
### Ubuntu/Debian (tar.gz)
|
||||
```bash
|
||||
systemctl restart xxxigcc
|
||||
```
|
||||
|
||||
### Ubuntu/Debian (DEB)
|
||||
```bash
|
||||
systemctl restart xxxigcc-daemon
|
||||
```
|
||||
|
||||
## 验证配置
|
||||
|
||||
### 检查配置文件语法
|
||||
```bash
|
||||
jq . /etc/xxxigcc/config.json
|
||||
```
|
||||
|
||||
### 查看运行状态
|
||||
```bash
|
||||
systemctl status xxxigcc-daemon
|
||||
journalctl -u xxxigcc-daemon -f
|
||||
```
|
||||
|
||||
## 相关链接
|
||||
|
||||
- [配置文件参考](../reference/config-json-schema.md)
|
||||
- [性能优化指南](how-to-optimize-performance.md)
|
||||
- [集中化管理配置](how-to-connect-nodes-to-cc.md)
|
||||
155
llmdoc/guides/how-to-install-via-tarball.md
Normal file
155
llmdoc/guides/how-to-install-via-tarball.md
Normal 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#服务管理)
|
||||
Reference in New Issue
Block a user