Upload 21 files

.env

@@ -0,0 +1,29 @@
+# Simple Clash Relay 环境变量配置
+
+# 必需：订阅链接
+# 这是您的机场提供的订阅链接，用于获取节点列表
+SUB_URL=https://xn--cp3a08l.com/api/v1/client/subscribe?token=your-token
+
+# 必需：API密钥
+# 用于保护API接口，请设置一个强密码
+API_KEY=clash-proxy-key
+
+# 可选：端口配置
+# -------------
+# Flask应用监听端口（默认7860，Hugging Face Spaces要求）
+# 用于访问Web界面和API
+FLASK_PORT=7860
+
+# Clash代理监听端口（默认7890）
+# 用于实际的代理服务
+CLASH_PROXY_PORT=7890
+
+# Clash API监听端口（默认9090）
+# 用于Clash内部API通信，不需要对外暴露
+CLASH_API_PORT=9090
+
+# 可选：Worker进程数量（默认为CPU核心数+1）
+# WORKER_COUNT=4
+
+# 可选：日志级别（默认INFO）
+LOG_LEVEL=INFO 

README.md

@@ -8,22 +8,33 @@ app_port: 7860
 pinned: false
 ---
 
-# Simple Clash Relay
+# Clash Proxy Service
 
-一个轻量级的自建Clash代理服务，可通过API控制节点切换。
+一个轻量级的自建Clash代理服务，适用于Hugging Face部署，可通过Web UI和API控制。提供HTTP和SOCKS5代理，支持订阅链接和手动配置文件上传。
 
 ## 功能特点
 
-- 🚀 **轻量级**：基于Python Flask和Clash Core，最小化依赖
-- 🔄 **机场订阅支持**：自动下载并转换您的机场订阅链接
-- 🔌 **多端口服务**：
+- 🚀 **轻量级架构**：基于Python Flask和Clash Meta，资源占用小
+- 🔄 **多种配置方式**：
+  - 支持机场订阅链接自动下载转换
+  - 支持手动上传Clash配置文件
+- 🌐 **完整的代理功能**：
+  - HTTP/HTTPS代理 (端口7890)
+  - SOCKS5代理 (端口7890)
+- 🖥️ **内置控制面板**：
+  - 集成Yacd控制界面，可视化管理代理
+  - 基础的操作面板，简化常用操作
+- 🔌 **暴露的端口**：
   - **7860**: Web界面和API服务(Hugging Face默认端口)
-  - **7890**: Clash代理服务
-  - **9090**: Clash内部API服务
-- 🔒 **API认证**：通过API Key保护控制API
-- 🔄 **动态切换节点**：通过API随时切换使用的节点
-- 🐳 **容器化**：完整的Docker支持，便于部署
-- 🔥 **Hugging Face友好**：针对Hugging Face Spaces平台优化
+  - **7890**: Clash代理服务(HTTP/SOCKS5)
+  - **9090**: Clash内部API服务(通常不需直接访问)
+- 🔒 **安全性设计**：
+  - API密钥保护所有控制接口
+  - 可选的配置加密存储
+- 🌍 **兼容性**：
+  - 适用于Hugging Face Spaces
+  - 支持Docker本地部署
+  - 兼容各类Clash客户端
 
 ## 系统要求
 
@@ -130,95 +141,184 @@ simple-clash-relay/
      - `SUB_URL`: 你的订阅链接
      - `API_KEY`: 你的API密钥
 
-## API使用
+## 使用教程：为其他项目提供代理
 
-所有API请求需要在请求头中包含`X-API-Key: 你的API密钥`。
+### 基本代理地址
 
-### 获取节点列表
+服务部署成功后，您可以使用以下地址作为代理：
 
-```
-GET /api/nodes
-```
+对于部署在Hugging Face上的服务：
+- **HTTP/HTTPS代理**：`https://clash-linux-clash.hf.space/proxy`
+- **SOCKS5代理**：`socks5://clash-linux-clash.hf.space:7890`（注意：SOCKS5在Hugging Face上可能受限）
 
-响应:
-```json
-{
-  "success": true,
-  "nodes": ["节点A", "节点B", "节点C"]
-}
-```
+对于本地部署的服务：
+- **HTTP/HTTPS代理**：`http://localhost:7890`
+- **SOCKS5代理**：`socks5://localhost:7890`
 
-### 切换节点
+### 在不同场景中使用代理
 
-```
-PUT /api/switch
-Content-Type: application/json
+#### 1. Python程序
+
+```python
+import requests
 
-{
-  "node": "节点B"
+proxies = {
+    "http": "http://clash-linux-clash.hf.space/proxy",
+    "https": "http://clash-linux-clash.hf.space/proxy"
 }
+
+response = requests.get("https://api.openai.com/v1/...", proxies=proxies)
 ```
 
-响应:
-```json
-{
-  "success": true,
-  "message": "已切换到节点: 节点B"
-}
+#### 2. curl命令
+
+```bash
+curl -x http://clash-linux-clash.hf.space/proxy https://api.openai.com/v1/...
 ```
 
-### 获取当前节点
+#### 3. 在其他Hugging Face项目中使用
+
+在其他Hugging Face项目的配置中，添加环境变量：
 
 ```
-GET /api/current
+HTTP_PROXY=http://clash-linux-clash.hf.space/proxy
+HTTPS_PROXY=http://clash-linux-clash.hf.space/proxy
 ```
 
-响应:
-```json
-{
-  "success": true,
-  "current_node": "节点B"
-}
+#### 4. 在NPM项目中使用
+
+```bash
+# 设置npm代理
+npm config set proxy http://clash-linux-clash.hf.space/proxy
+npm config set https-proxy http://clash-linux-clash.hf.space/proxy
 ```
 
-### 刷新订阅
+#### 5. Docker容器中使用
 
-```
-POST /api/refresh
+```bash
+docker run -e HTTP_PROXY=http://clash-linux-clash.hf.space/proxy -e HTTPS_PROXY=http://clash-linux-clash.hf.space/proxy your-image
 ```
 
-响应:
-```json
-{
-  "success": true,
-  "message": "订阅已刷新，Clash已重启"
-}
+#### 6. Git中使用
+
+```bash
+git config --global http.proxy http://clash-linux-clash.hf.space/proxy
+git config --global https.proxy http://clash-linux-clash.hf.space/proxy
 ```
 
-## 在应用中使用代理
+### 切换代理节点
+
+为获得最佳性能，您可能需要切换使用的代理节点：
+
+1. 访问 `https://clash-linux-clash.hf.space/ui/`
+2. 首次使用时设置外部控制器地址为 `/clashapi`，密钥为您的API密钥(默认为`changeme`)
+3. 在Proxies选项卡中，选择GLOBAL策略组，然后选择一个可用的节点
+
+## 详细使用指南
+
+### 1. 配置管理
+
+#### 使用订阅链接
+
+服务默认使用环境变量`SUB_URL`中配置的订阅链接。如需刷新订阅：
+
+1. 访问Web UI `https://clash-linux-clash.hf.space/`
+2. 点击"刷新订阅并重启Clash"按钮
+3. 输入API密钥(默认为`changeme`)
+
+#### 上传自定义配置
+
+如果您有现成的Clash配置文件：
+
+1. 访问Web UI `https://clash-linux-clash.hf.space/`
+2. 在"���传手动配置"区域选择您的配置文件(.yaml或.yml)
+3. 点击"上传并应用配置"按钮
+4. 输入API密钥
+
+#### 恢复使用订阅
+
+如果您想从手动配置恢复到使用订阅：
+
+1. 在"调试与恢复"区域点击"清理配置并重启"
+2. 确认操作并输入API密钥
+
+### 2. 查看当前配置
+
+您可以检查当前使用的配置文件内容：
+
+1. 在Web UI中点击"查看当前配置文件"
+2. 输入API密钥
+3. 配置内容将显示在页面上
+
+### 3. 代理控制面板(Yacd)
+
+高级用户可以使用内置的Yacd面板管理代理：
+
+1. 访问 `https://clash-linux-clash.hf.space/ui/`
+2. 首次使用时需配置：
+   - 外部控制器地址：`/clashapi`
+   - 密钥：您的API密钥(默认为`changeme`)
+3. 在此面板中，您可以：
+   - 切换节点
+   - 查看连接日志
+   - 管理规则
+   - 监控网络流量
+
+### 4. API接口
+
+系统提供了以下API接口，所有请求都需要在Header中包含`X-API-Key`：
+
+- `GET /api/nodes` - 获取所有可用节点
+- `GET /api/current` - 获取当前使用的节点
+- `PUT /api/switch` - 切换到指定节点
+- `POST /api/refresh` - 刷新订阅并重启Clash
+- `POST /api/upload_config` - 上传自定义配置文件
+- `POST /debug/clean` - 清理配置并重新初始化
+- `GET /debug/config` - 获取当前配置文件内容
+
+### 5. 排错指南
+
+如果遇到问题，请尝试以下步骤：
+
+1. **代理连接失败**：
+   - 确认代理地址正确
+   - 检查是否选择了可用的节点
+   - 尝试切换到其他节点
+
+2. **节点无法连接**：
+   - 刷新订阅获取最新节点
+   - 检查配置文件是否正确
+   - 尝试上传新的配置文件
+
+3. **界面加载问题**：
+   - 清除浏览器缓存
+   - 使用无痕模式访问
+   - 检查浏览器控制台是否有错误信息
 
-您可以通过以下方式使用代理服务：
+4. **配置问题**：
+   - 使用"清理配置并重启"功能重置系统
+   - 检查订阅链接是否有效
+   - 检查上传的配置文件格式是否正确
 
-### 标准模式
-- HTTP代理: `http://your-server-ip:7890`
-- SOCKS5代理: `socks5://your-server-ip:7890`
+## 自定义部署
 
-### Hugging Face Spaces模式 (代理路径转发)
-- HTTP代理: `http://your-space-name.hf.space/proxy`
-- SOCKS5代理: `socks5://your-space-name.hf.space/proxy`
+### Docker环境变量
 
-### 在cursor-to-openai项目中配置
+自行部署时可使用以下环境变量：
 
-修改您的cursor-to-openai项目配置，设置代理地址：
-- 本地部署：`http://localhost:7890`
-- Hugging Face部署：`http://your-space-name.hf.space/proxy`
+- `SUB_URL`：订阅链接URL
+- `API_KEY`：API访问密钥(默认为"changeme")
+- `FLASK_PORT`：Web界面端口(默认7860)
+- `CLASH_PROXY_PORT`：Clash代理端口(默认7890)
+- `CLASH_API_PORT`：Clash API端口(默认9090)
+- `CLEAN_CONFIG`：启动时是否清理配置(true/false)
 
 ## 注意事项
 
-- 本项目仅用于个人学习和研究目的
-- 请遵守当地法律法规，不要用于非法用途
-- 确保设置强密码API Key以保护接口
+- 本项目仅供学习研究使用，请遵守相关法律法规
 - Hugging Face Spaces有资源和流量限制，请合理使用
+- 为保障安全，请修改默认API密钥
+- 上传的配置文件会覆盖订阅内容，如需恢复请使用清理功能
 
 ## 许可
 

app/main.py

@@ -7,7 +7,10 @@ Simple Clash Relay - Flask 应用入口
 
 import os
 import logging
+import socket
+import threading
 from flask import Flask, request, jsonify, Response, redirect, send_from_directory, flash
+from flask_sockets import Sockets # 导入 Sockets
 from .clash_manager import ClashManager
 from .sub_manager import SubscriptionManager
 from .auth import authenticate
@@ -15,6 +18,9 @@ import requests
 from functools import wraps
 from werkzeug.utils import secure_filename
 import time
+import gevent # 导入 gevent
+from gevent import pywsgi
+from geventwebsocket.handler import WebSocketHandler # 导入 WebSocketHandler
 
 # 配置日志
 logging.basicConfig(
@@ -33,9 +39,10 @@ CLASH_API_PORT = int(os.environ.get("CLASH_API_PORT", 9090))
 # 添加标记文件路径
 MANUAL_CONFIG_MARKER = os.path.join(os.path.dirname(__file__), "data", ".use_manual_config")
 
-# 初始化Flask应用
+# 初始化Flask应用 和 Sockets
 app = Flask(__name__, static_folder='static')
 app.secret_key = os.environ.get("FLASK_SECRET_KEY", "supersecretkey") # 用于flash消息
+sockets = Sockets(app) # 初始化 Sockets
 
 # 初始化管理器
 clash_manager = None
@@ -433,6 +440,92 @@ def upload_config():
             os.remove(marker_path)
         return jsonify({"success": False, "error": f"处理上传文件时出错: {str(e)}"}), 500
 
+# --- 新增：WebSocket代理隧道 --- 
+
+def forward_websocket_to_tcp(ws, tcp_socket):
+    """从WebSocket读取数据并写入TCP Socket"""
+    try:
+        while not ws.closed:
+            message = ws.receive()
+            if message:
+                # logger.debug(f"WS -> TCP: 转发 {len(message)} 字节")
+                tcp_socket.sendall(message)
+            else:
+                # WebSocket连接关闭或收到空消息
+                break
+    except Exception as e:
+        logger.warning(f"WS -> TCP 转发错误: {e}")
+    finally:
+        logger.info("WS -> TCP 转发协程结束")
+        if not tcp_socket._closed:
+            tcp_socket.close()
+        if not ws.closed:
+            ws.close()
+
+def forward_tcp_to_websocket(tcp_socket, ws):
+    """从TCP Socket读取数据并写入WebSocket"""
+    try:
+        while not ws.closed:
+            data = tcp_socket.recv(4096) # 每次最多读取4KB
+            if data:
+                # logger.debug(f"TCP -> WS: 转发 {len(data)} 字节")
+                ws.send(data)
+            else:
+                # TCP连接关闭
+                break
+    except Exception as e:
+        # 忽略WebSocket可能已经关闭的错误
+        if "closed" not in str(e).lower(): 
+            logger.warning(f"TCP -> WS 转发错误: {e}")
+    finally:
+        logger.info("TCP -> WS 转发协程结束")
+        if not tcp_socket._closed:
+            tcp_socket.close()
+        if not ws.closed:
+            ws.close()
+
+@sockets.route('/wsproxy')
+def websocket_proxy_tunnel(ws):
+    """处理WebSocket连接，建立到Clash代理端口的TCP隧道"""
+    global clash_manager, initialization_error
+
+    logger.info(f"收到新的WebSocket连接请求: {request.remote_addr}")
+
+    # 1. 检查Clash是否运行
+    if clash_manager is None:
+        logger.error(f"Clash服务未运行，无法建立WebSocket隧道")
+        ws.close(reason="Clash service is not running")
+        return
+
+    # 2. 建立到内部Clash代理端口的TCP连接
+    target_host = "127.0.0.1"
+    target_port = CLASH_PROXY_PORT # 7890
+    tcp_socket = None
+    try:
+        tcp_socket = socket.create_connection((target_host, target_port), timeout=5)
+        logger.info(f"成功连接到内部Clash代理端口: {target_host}:{target_port}")
+    except Exception as e:
+        logger.error(f"连接到内部Clash代理端口失败: {e}")
+        ws.close(reason=f"Failed to connect to internal proxy: {e}")
+        return
+
+    # 3. 创建两个协程进行双向数据转发
+    logger.info("启动WebSocket和TCP之间的双向转发协程...")
+    ws_to_tcp_greenlet = gevent.spawn(forward_websocket_to_tcp, ws, tcp_socket)
+    tcp_to_ws_greenlet = gevent.spawn(forward_tcp_to_websocket, tcp_socket, ws)
+
+    # 4. 等待任一协程结束 (表示连接中断)
+    try:
+        gevent.joinall([ws_to_tcp_greenlet, tcp_to_ws_greenlet], raise_error=True)
+    except Exception as e:
+        logger.warning(f"转发协程出现错误: {e}")
+    finally:
+        logger.info("WebSocket隧道连接已关闭")
+        if tcp_socket and not tcp_socket._closed:
+            tcp_socket.close()
+        if ws and not ws.closed:
+            ws.close()
+
 # --- 基础路由 --- 
 
 @app.route('/', methods=['GET'])
@@ -646,6 +739,7 @@ def index():
 if __name__ == "__main__":
     # 如果直接运行此文件，将初始化应用并启动Flask服务器
     initialize_once()
-    logger.info(f"启动Flask服务器，监听端口: {FLASK_PORT}")
-    app.run(host="0.0.0.0", port=FLASK_PORT) 
-    app.run(host="0.0.0.0", port=FLASK_PORT) 
+    logger.info(f"启动 Flask/Gevent WebSocket 服务器，监听端口: {FLASK_PORT}")
+    # 使用 gevent 的 WSGI 服务器来支持 WebSocket
+    server = pywsgi.WSGIServer(('0.0.0.0', FLASK_PORT), app, handler_class=WebSocketHandler)
+    server.serve_forever() 

requirements.txt

@@ -4,4 +4,6 @@ requests==2.28.1
 Werkzeug==2.0.1
 PyYAML==6.0.1
 # pyyaml==6.0 # 已通过 apk 安装 
-# 添加与 Flask==2.0.1 兼容的版本 
+# 添加与 Flask==2.0.1 兼容的版本 
+flask-sockets
+gevent