修改 README
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

This commit is contained in:
2025-12-03 16:43:00 +08:00
parent 89270dadcd
commit e88c5865e6

View File

@@ -1,8 +1,11 @@
# XXXigCC Proxy
禁用捐赠功能的 xmrigCC-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 架构
@@ -10,7 +13,7 @@
- 🐧 **多发行版**:支持 Ubuntu 和 Alpine Linux
- 🔄 **自动更新**:可通过 Debian 仓库安装 (bookworm/trixie)
## 快速安装
## 🚀 快速开始
### Debian/Ubuntu推荐
@@ -45,7 +48,7 @@ tar -xzf xxxigcc-proxy-amd64-ubuntu-3.4.6-xg1.tar.gz
./xxxigcc-proxy --config=config.json
```
## 基本使用
## 📋 基本使用
通过 Debian 软件包安装后:
@@ -63,7 +66,7 @@ sudo systemctl status xxxigcc-proxy
sudo journalctl -u xxxigcc-proxy -f
```
## 配置说明
## ⚙️ 配置说明
默认配置文件位置:
- Debian 软件包:`/etc/xxxigcc-proxy/config.json`
@@ -75,9 +78,9 @@ sudo journalctl -u xxxigcc-proxy -f
- `access-log-file`:访问日志文件路径
- `log-file`:常规日志文件路径
## 修改内容
## 🔄 修改内容
相比上游 xmrigCC-proxy,本版本包含以下修改:
本项目基于 [Bendr0id/XMRigCC Proxy](https://github.com/Bendr0id/XMRigCC-Proxy) 进行以下修改:
1. **禁用捐赠**`kDefaultDonateLevel` 设为 0
2. **捐赠端点**:重定向到本地 (127.0.0.1)
@@ -85,3 +88,19 @@ sudo journalctl -u xxxigcc-proxy -f
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) - 核心挖矿引擎
## ⚠️ 免责声明
本软件仅供学习和研究使用。使用本软件进行挖矿活动请遵守当地法律法规。作者不对使用本软件造成的任何损失或法律问题负责。