Skip to content

Commit 063e207

Browse files
authored
Create README.md
1 parent be1c2fe commit 063e207

1 file changed

Lines changed: 153 additions & 0 deletions

File tree

README.md

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# ECH Workers 客户端
2+
3+
跨平台的 ECH Workers 代理客户端,支持 Windows 和 macOS。
4+
5+
## 致谢
6+
7+
本项目的客户端和 Go 核心程序均基于 [白嫖哥](https://t.me/bestcfipas) 的原始代码开发。
8+
9+
- **原始项目来源**: [白嫖哥 - 优选IP](https://t.me/bestcfipas)
10+
- **Telegram 频道**: [@bestcfipas](https://t.me/bestcfipas)
11+
12+
## 功能特性
13+
14+
- ✅ 服务器配置管理(支持多个服务器配置)
15+
- ✅ 启动/停止代理进程
16+
- ✅ 实时日志显示
17+
- ✅ 系统托盘图标(可选)
18+
- ✅ 开机自动启动
19+
- ✅ 配置自动保存
20+
21+
## 快速开始
22+
23+
### 方法 1: 使用预编译版本(推荐)
24+
25+
[GitHub Releases](https://github.com/your-repo/releases) 下载对应平台的压缩包:
26+
27+
- **Windows**: `ECHWorkers-windows-amd64.zip`
28+
- **macOS Intel**: `ECHWorkers-darwin-amd64.zip`
29+
- **macOS Apple Silicon**: `ECHWorkers-darwin-arm64.zip`
30+
31+
解压后直接运行:
32+
- **Windows**: 双击 `ECHWorkersGUI.exe` 启动 GUI,或运行 `ech-workers.exe` 使用命令行
33+
- **macOS**: 运行 `./ECHWorkersGUI` 启动 GUI,或运行 `./ech-workers` 使用命令行
34+
35+
> **注意**: 预编译版本已包含所有依赖,无需安装 Python 或任何其他软件。
36+
37+
### 方法 2: 从源码编译
38+
39+
#### 编译 Go 程序
40+
41+
```bash
42+
# 初始化 Go 模块
43+
go mod init ech-workers
44+
go mod tidy
45+
46+
# 编译
47+
go build -o ech-workers ech-workers.go
48+
```
49+
50+
#### 运行 Python 客户端
51+
52+
```bash
53+
# 安装依赖
54+
pip install PyQt5
55+
56+
# 运行
57+
python3 gui.py
58+
```
59+
60+
## 文件说明
61+
62+
### 核心文件
63+
- `ech-workers.go` - Go 源码(核心代理程序,基于 [白嫖哥](https://t.me/bestcfipas) 的原始代码)
64+
- `gui.py` - Python GUI 客户端(使用 PyQt5,基于 [白嫖哥](https://t.me/bestcfipas) 的原始 Windows 客户端)
65+
66+
### 配置文件
67+
- `go.mod`, `go.sum` - Go 模块文件
68+
- `requirements.txt` - Python 依赖列表
69+
70+
## 系统要求
71+
72+
- **Windows**: Windows 10+
73+
- **macOS**: macOS 10.13+
74+
- **Python**: 3.6+
75+
- **Go**: 1.23+ (仅编译时需要,ECH 功能需要此版本)
76+
77+
## 配置说明
78+
79+
配置文件保存在:
80+
- **Windows**: `%APPDATA%\ECHWorkersClient\config.json`
81+
- **macOS**: `~/Library/Application Support/ECHWorkersClient/config.json`
82+
- **Linux**: `~/.config/ECHWorkersClient/config.json`
83+
84+
## 使用说明
85+
86+
1. **配置服务器**
87+
- 点击"新增"添加服务器配置
88+
- 填写服务地址和监听地址
89+
- 可选:填写身份令牌、IP、DNS、ECH 等高级选项
90+
91+
2. **启动代理**
92+
- 点击"启动代理"按钮
93+
- 查看日志区域了解运行状态
94+
95+
3. **系统托盘**(如果安装了 pystray)
96+
- 应用会在菜单栏显示图标
97+
- 点击图标可以打开/隐藏窗口
98+
99+
## 故障排除
100+
101+
### PyQt5 安装问题
102+
103+
如果遇到 PyQt5 安装问题:
104+
```bash
105+
# macOS
106+
pip3 install --user PyQt5
107+
#
108+
pip3 install --break-system-packages PyQt5
109+
110+
# Windows
111+
pip install PyQt5
112+
```
113+
114+
### 找不到 ech-workers
115+
116+
确保已编译 Go 程序:
117+
```bash
118+
go build -o ech-workers ech-workers.go
119+
```
120+
121+
## 开发
122+
123+
### 本地测试
124+
125+
```bash
126+
# 编译 Go
127+
go build -o ech-workers ech-workers.go
128+
129+
# 测试 Python
130+
python3 -m py_compile gui.py
131+
```
132+
133+
### GitHub Actions
134+
135+
推送标签会自动触发构建和发布:
136+
```bash
137+
git tag v1.0.0
138+
git push origin v1.0.0
139+
```
140+
141+
## 许可证
142+
143+
本项目基于 [白嫖哥](https://t.me/bestcfipas) 的原始代码开发。
144+
145+
## 相关链接
146+
147+
- **原始项目**: [白嫖哥 - 优选IP Telegram 频道](https://t.me/bestcfipas)
148+
- **Telegram**: [@bestcfipas](https://t.me/bestcfipas)
149+
150+
## 贡献
151+
152+
欢迎提交 Issue 和 Pull Request!
153+

0 commit comments

Comments
 (0)