添加 README

2025-12-03 14:47:29 +08:00
parent 51d7a66c56
commit 89270dadcd
1 changed files with 87 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,87 @@
+# XXXigCC Proxy
+
+禁用捐赠功能的 xmrigCC-proxy 修改版本。
+
+## 特性
+
+- 🚫 **零捐赠**：捐赠等级设为 0，所有捐赠端点已禁用
+- 🏗️ **多架构**：原生支持 AMD64 和 ARM64 架构
+- 📦 **多种格式**：提供二进制包 (.tar.gz) 和 Debian 软件包 (.deb)
+- 🐧 **多发行版**：支持 Ubuntu 和 Alpine Linux
+- 🔄 **自动更新**：可通过 Debian 仓库安装 (bookworm/trixie)
+
+## 快速安装
+
+### Debian/Ubuntu（推荐）
+
+**Debian 12 (bookworm):**
+
+```bash
+sudo curl https://gitea.bcde.io/api/packages/wangdefa/debian/repository.key -o /etc/apt/keyrings/gitea-wangdefa.asc
+echo "deb [signed-by=/etc/apt/keyrings/gitea-wangdefa.asc] https://gitea.bcde.io/api/packages/wangdefa/debian bookworm main" | sudo tee -a /etc/apt/sources.list.d/wangdefa.list
+sudo apt-get update
+sudo apt-get install xxxigcc-proxy
+```
+
+**Debian 13 (trixie):**
+
+```bash
+sudo curl https://gitea.bcde.io/api/packages/wangdefa/debian/repository.key -o /etc/apt/keyrings/gitea-wangdefa.asc
+echo "deb [signed-by=/etc/apt/keyrings/gitea-wangdefa.asc] https://gitea.bcde.io/api/packages/wangdefa/debian trixie main" | sudo tee -a /etc/apt/sources.list.d/wangdefa.list
+sudo apt-get update
+sudo apt-get install xxxigcc-proxy
+```
+
+### 二进制下载
+
+从 [Releases](https://gitea.bcde.io/wangdefa/xxxigcc-proxy/releases) 下载：
+
+```bash
+# 下载并解压
+wget https://gitea.bcde.io/api/packages/wangdefa/generic/xxxigcc-proxy/3.4.6-xg1/xxxigcc-proxy-amd64-ubuntu-3.4.6-xg1.tar.gz
+tar -xzf xxxigcc-proxy-amd64-ubuntu-3.4.6-xg1.tar.gz
+
+# 运行
+./xxxigcc-proxy --config=config.json
+```
+
+## 基本使用
+
+通过 Debian 软件包安装后：
+
+```bash
+# 编辑配置文件
+sudo nano /etc/xxxigcc-proxy/config.json
+
+# 重启服务
+sudo systemctl restart xxxigcc-proxy
+
+# 查看状态
+sudo systemctl status xxxigcc-proxy
+
+# 查看日志
+sudo journalctl -u xxxigcc-proxy -f
+```
+
+## 配置说明
+
+默认配置文件位置：
+- Debian 软件包：`/etc/xxxigcc-proxy/config.json`
+- 二进制版本：`./config.json`（与程序同目录）
+
+主要配置选项：
+- `bind`：监听地址和端口（默认：`0.0.0.0:3333`）
+- `pools`：上游矿池连接配置
+- `access-log-file`：访问日志文件路径
+- `log-file`：常规日志文件路径
+
+## 修改内容
+
+相比上游 xmrigCC-proxy，本版本包含以下修改：
+
+1. **禁用捐赠**：`kDefaultDonateLevel` 设为 0
+2. **捐赠端点**：重定向到本地 (127.0.0.1)
+3. **详细日志**：默认启用详细日志模式
+4. **项目重命名**："xmrigcc" → "xxxigcc"
+
+所有修改通过 [init.sh](init.sh) 在构建过程中自动应用。