Files
xxxigcc-proxy/README.md
Wang Defa e88c5865e6
All checks were successful
Build and Release / build-and-test (arm64, alpine) (push) Successful in 8s
Build and Release / build-and-test (amd64, alpine) (push) Successful in 14s
Build and Release / build-and-test (arm64, ubuntu) (push) Successful in 14s
Build and Release / build-and-test (amd64, ubuntu) (push) Successful in 27s
Build and Release / release (push) Has been skipped
修改 README
2025-12-03 16:43:00 +08:00

106 lines
3.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# XXXigCC Proxy
> 禁用捐赠功能的 XMRigCC Proxy 修改版本。
[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](.gitea/workflows/ci.yaml)
## 🎯 主要特性
- 🚫 **零捐赠**:捐赠等级设为 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`:常规日志文件路径
## 🔄 修改内容
本项目基于 [Bendr0id/XMRigCC Proxy](https://github.com/Bendr0id/XMRigCC-Proxy) 进行以下修改:
1. **禁用捐赠**`kDefaultDonateLevel` 设为 0
2. **捐赠端点**:重定向到本地 (127.0.0.1)
3. **详细日志**:默认启用详细日志模式
4. **项目重命名**"xmrigcc" → "xxxigcc"
所有修改通过 [init.sh](init.sh) 在构建过程中自动应用。
## 📝 许可证
本项目基于 GPL-3.0 许可证开源。
- 原始项目:[XMRigCC proxy](https://github.com/Bendr0id/XMRigcc-Proxy) (GPL-3.0)
- 修改内容:详见 [init.sh](init.sh)
## 🙏 致谢
- [XMRigCC Proxy](https://github.com/Bendr0id/XMRigcc-Proxy) - 原始项目
- [XMRig Proxy](https://github.com/xmrig/xmrig-proxy) - 核心挖矿引擎
## ⚠️ 免责声明
本软件仅供学习和研究使用。使用本软件进行挖矿活动请遵守当地法律法规。作者不对使用本软件造成的任何损失或法律问题负责。