Skip to content

Commit 80a089e

Browse files
byJoeybyJoey
authored
Update README.md
1 parent 93d957d commit 80a089e

File tree

1 file changed

+10
-145
lines changed

1 file changed

+10
-145
lines changed

‎README.md‎

Lines changed: 10 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@
5757
#### 🎭 协议配置（新增）
5858
| 变量名 | 值 | 说明 |
5959
| :--- | :--- | :--- |
60-
| `enableVless` | `yes/no` | **可选**。启用VLESS协议（默认启用） |
61-
| `enableTrojan` | `yes/no` | **可选**。启用Trojan协议（默认禁用） |
62-
| `enableXhttp` | `yes/no` | **可选**。启用xhttp协议（默认禁用） |
63-
| `trojanPassword` | `自定义密码` | **可选**。Trojan协议密码，留空则使用UUID |
60+
| `ev` | `yes/no` | **可选**。启用VLESS协议（默认启用） |
61+
| `et` | `yes/no` | **可选**。启用Trojan协议（默认禁用） |
62+
| `ex` | `yes/no` | **可选**。启用xhttp协议（默认禁用） |
63+
| `tp` | `自定义密码` | **可选**。Trojan协议密码，留空则使用UUID |
6464

6565
#### 🎯 图形化配置（推荐）
6666
- **KV存储配置**：在Workers中创建KV命名空间，绑定环境变量 `C`
@@ -72,15 +72,15 @@
7272
| :--- | :--- | :--- |
7373
| `yx` | `自定义优选IP/域名` | **可选**。支持节点命名，格式：`1.1.1.1:443#香港节点,8.8.8.8:53#Google DNS` |
7474
| `yxURL` | `优选IP来源URL` | **可选**。自定义优选IP列表来源URL，留空则使用默认地址 |
75-
| `subConverterUrl` | `订阅转换地址` | **可选**。自定义订阅转换服务URL，默认：`https://url.v1.mk/sub` |
76-
| `enablePreferredDomains` | `yes/no` | **可选**。启用优选域名（默认启用） |
77-
| `enablePreferredIPs` | `yes/no` | **可选**。启用优选IP（默认启用） |
78-
| `enableGithubIPs` | `yes/no` | **可选**。启用GitHub默认优选（默认启用） |
75+
| `scu` | `订阅转换地址` | **可选**。自定义订阅转换服务URL，默认：`https://url.v1.mk/sub` |
76+
| `epd` | `yes/no` | **可选**。启用优选域名（默认启用） |
77+
| `epi` | `yes/no` | **可选**。启用优选IP（默认启用） |
78+
| `egi` | `yes/no` | **可选**。启用GitHub默认优选（默认启用） |
7979
| `qj` | `no` | **可选**。降级控制，设置为`no`时启用降级模式：CF直连失败→SOCKS5连接→fallback地址 |
8080
| `dkby` | `yes` | **可选**。TLS控制，设置为`yes`时只生成TLS节点，不生成非TLS节点（如80端口） |
8181
| `yxby` | `yes` | **可选**。优选控制，设置为`yes`时关闭所有优选功能，只使用原生地址，不生成优选IP和域名节点 |
8282
| `rm` | `no` | **可选**。地区匹配控制，设置为`no`时关闭地区智能匹配 |
83-
| `apiEnabled` | `yes` | **可选**。API管理开关，设置为`yes`时允许通过API动态管理优选IP（默认关闭） |
83+
| `ae` | `yes` | **可选**。API管理开关，设置为`yes`时允许通过API动态管理优选IP（默认关闭） |
8484

8585
#### 📦 KV存储设置（可选但推荐）
8686
1. 在Cloudflare Workers中创建KV命名空间
@@ -151,7 +151,7 @@ curl -X DELETE "https://your-worker.workers.dev/{UUID或自定义路径}/api/pre
151151

152152
#### 🔐 代码混淆增强（v2.0 新增）
153153
- **关键词编码**：websocket、clash、v2ray等敏感关键词Base64编码
154-
- **变量名混淆**：配置变量名缩短混淆（enableVless → ev）
154+
- **变量名混淆**：所有配置变量名统一使用短名（ev/et/ex/tp/scu等）
155155
- **调试清理**：移除所有console调试语句
156156
- **特征隐藏**：降低关键词匹配风险95%+
157157
- **用户友好**：HTML界面保持清晰可读
@@ -212,138 +212,3 @@ curl -X DELETE "https://your-worker.workers.dev/{UUID或自定义路径}/api/pre
212212
## Star History
213213

214214
[![Star History Chart](https://api.star-history.com/svg?repos=byJoey/cfnew&type=Timeline)](https://www.star-history.com/#byJoey/cfnew&Timeline&LogScale)
215-
| `dkby` | `yes` | **可选**。TLS控制，设置为`yes`时只生成TLS节点，不生成非TLS节点（如80端口） |
216-
| `yxby` | `yes` | **可选**。优选控制，设置为`yes`时关闭所有优选功能，只使用原生地址，不生成优选IP和域名节点 |
217-
| `rm` | `no` | **可选**。地区匹配控制，设置为`no`时关闭地区智能匹配 |
218-
| `apiEnabled` | `yes` | **可选**。API管理开关，设置为`yes`时允许通过API动态管理优选IP（默认关闭） |
219-
220-
#### 📦 KV存储设置（可选但推荐）
221-
1. 在Cloudflare Workers中创建KV命名空间
222-
2. 在Workers设置中绑定KV命名空间，变量名设为 `C`
223-
3. 重新部署Workers
224-
4. 访问 `/{你的UUID}` 即可使用图形化配置管理
225-
226-
#### 🔑 API快速开始
227-
1. https://github.com/byJoey/yx-tools/releases 优选软件
228-
2. **开启API功能**：访问 `/{UUID}` 或 `/{自定义路径}` → 找到"允许API管理"→ 选择"开启API管理"→ 保存
229-
3. **API路径说明**：
230-
- 使用 UUID：`/{UUID}/api/...`
231-
- 使用自定义路径（d变量）：`/{自定义路径}/api/...`
232-
4. **添加单个IP**：
233-
```bash
234-
curl -X POST "https://your-worker.workers.dev/{UUID}/api/preferred-ips" \
235-
-H "Content-Type: application/json" \
236-
-d '{"ip": "1.2.3.4", "port": 443, "name": "香港节点"}'
237-
```
238-
5. **批量添加IP**：
239-
```bash
240-
curl -X POST "https://your-worker.workers.dev/{UUID}/api/preferred-ips" \
241-
-H "Content-Type: application/json" \
242-
-d '[
243-
{"ip": "1.2.3.4", "port": 443, "name": "节点1"},
244-
{"ip": "5.6.7.8", "port": 8443, "name": "节点2"}
245-
]'
246-
```
247-
6. **一键清空**：
248-
```bash
249-
curl -X DELETE "https://your-worker.workers.dev/{UUID}/api/preferred-ips" \
250-
-H "Content-Type: application/json" \
251-
-d '{"all": true}'
252-
```
253-
254-
255-
256-
### 新功能
257-
258-
### 🎯 图形化配置管理
259-
- **KV存储支持**：使用Cloudflare KV存储持久化配置
260-
- **图形化界面**：访问 `/{你的UUID}` 或 `/{自定义路径}` 即可使用配置管理界面
261-
- **实时配置**：无需重新部署，配置立即生效
262-
- **配置优先级**：KV配置 > 环境变量 > 默认值
263-
- **路径灵活**：支持 UUID 模式和自定义路径模式
264-
265-
#### 🔐 多协议支持
266-
- **VLESS 协议**：默认启用，基于 WebSocket 的标准协议
267-
- **Trojan 协议**：支持 SHA224 密码认证，可自定义密码或使用 UUID
268-
- **xhttp 协议**：基于 HTTP POST 的伪装协议，需绑定自定义域名并开启 gRPC
269-
- **灵活切换**：可同时启用多个协议，也可只选择单一协议
270-
- **协议配置**：通过图形化界面轻松管理协议开关
271-
272-
#### 🛣️ 自定义路径（d 变量）
273-
- **自定义访问路径**：支持使用自定义路径代替 UUID
274-
- **路径示例**：设置 `d=/mypath` 后，访问 `https://worker.dev/mypath` 即可
275-
- **安全增强**：启用自定义路径后，UUID 路径自动禁用
276-
- **智能识别**：首页终端自动识别当前使用的是 UUID 还是自定义路径
277-
- **路径显示**：高级配置区实时显示当前使用的路径类型（u/d）
278-
279-
#### 🔄 订阅转换配置
280-
- **自定义转换地址**：支持自定义订阅转换 API 地址
281-
- **默认地址**：`https://url.v1.mk/sub`
282-
- **灵活配置**：可在高级控制区修改转换服务地址
283-
- **多客户端支持**：配合转换服务支持 Clash、Surge、Sing-box 等客户端
284-
285-
#### 🎛️ 内置优选类型控制
286-
- **优选域名**：控制是否包含 CF 优选域名节点
287-
- **优选 IP**：控制是否包含 CF 优选 IP 节点
288-
- **GitHub 默认优选**：控制是否包含 GitHub 上的默认优选节点
289-
- **灵活组合**：可任意组合启用，默认全部启用
290-
- **订阅精简**：根据需要选择性生成节点，减少订阅体积
291-
292-
#### 🚀 API动态管理
293-
- **API管理**：通过RESTful API动态管理优选IP，无需修改代码
294-
- **批量上报**：支持一次性批量添加多个优选IP
295-
- **一键清空**：支持清空所有优选IP，快速更新列表
296-
- **安全开关**：默认关闭，需在图形界面手动开启API功能
297-
- **自动合并**：API添加的IP与手动配置的yx变量自动合并
298-
- **实时同步**：API添加的IP立即在配置页面显示
299-
- **API端点**：
300-
- `GET /{UUID或自定义路径}/api/preferred-ips` - 查询优选IP列表
301-
- `POST /{UUID或自定义路径}/api/preferred-ips` - 添加优选IP（支持单个/批量）
302-
- `DELETE /{UUID或自定义路径}/api/preferred-ips` - 删除优选IP（支持单个/全部）
303-
304-
#### 🌍 手动指定地区
305-
- **地区选择**：支持手动指定Worker地区，覆盖自动检测
306-
- **设置方式**：`wk=SG` 或通过图形化界面选择
307-
- **支持地区**：US、SG、JP、HK、KR、DE、SE、NL、FI、GB
308-
- **智能显示**：系统状态会显示"手动指定地区"而非"自动检测"
309-
310-
#### 🏷️ 优选节点命名
311-
- **自定义名称**：支持为优选节点设置自定义名称
312-
- **格式支持**：`IP:端口#节点名称` 或 `IP:端口`（使用默认名称）
313-
- **示例**：`1.1.1.1:443#香港节点,8.8.8.8:53#Google DNS`
314-
- **默认格式**：未设置名称时自动生成 `自定义优选-IP:端口`
315-
316-
#### 📊 系统状态监控
317-
- **实时检测**：显示Worker地区、检测方式、ProxyIP状态
318-
- **智能匹配**：同地区 → 邻近地区 → 其他地区的选择逻辑
319-
- **状态指示**：可视化显示系统运行状态和配置信息
320-
321-
#### 🔧 高级控制选项
322-
- **订阅转换**：自定义订阅转换 API 地址
323-
- **优选类型**：控制内置优选（域名/IP/GitHub）的启用状态
324-
- **地区匹配控制**：`rm=no` 关闭地区智能匹配
325-
- **降级控制**：`qj=no` 启用降级模式（CF直连失败→SOCKS5→fallback）
326-
- **TLS控制**：`dkby=yes` 只生成TLS节点，不生成非TLS节点
327-
- **优选控制**：`yxby=yes` 关闭所有优选功能
328-
- **路径监控**：实时显示当前使用的路径类型（UUID/自定义路径）
329-
330-
#### 🎨 多客户端支持
331-
- **订阅格式**：支持Clash、Surge、Sing-box、Loon、V2Ray等
332-
- **自动转换**：根据客户端类型自动生成对应配置
333-
- **一键获取**：图形化界面一键生成订阅链接
334-
335-
#### ⚡ 性能优化
336-
- **智能优选**：每15分钟自动优选一次，保持最佳性能
337-
- **容错机制**：多重备用方案，确保服务稳定性
338-
- **缓存优化**：智能缓存机制，减少重复计算
339-
340-
### 致谢
341-
342-
* 本项目基于 [zizifn/edgetunnel](https://github.com/zizifn/edgetunnel) 修改，感谢原作者的贡献。
343-
* 本项目内置ProxyIP 来自CM [[cmliu](https://github.com/cmliu)) ，感谢作者的贡献。
344-
* 本项目反代IP来着前端独苗kejiland [[qwer-search](https://github.com/qwer-search)) ，感谢作者的贡献。
345-
## Star History
346-
347-
[![Star History Chart](https://api.star-history.com/svg?repos=byJoey/cfnew&type=Timeline)](https://www.star-history.com/#byJoey/cfnew&Timeline&LogScale)
348-
349-

0 commit comments

Comments
 (0)