# cmliu/edgetunnel architecture

> Architecture diagram of the GitHub repository cmliu/edgetunnel, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cmliu/edgetunnel
- Repository: https://github.com/cmliu/edgetunnel

## Overview

下面针对 “edgetunnel” 项目，说明如何绘制一份最准确、最清晰的系统设计图（架构图）。这个项目本质上是一个部署在 Cloudflare 平台上的 Serverless 脚本（CF Worker/Pages），用于将 VLESS 配置信息在线转换为各类客户端可识别的订阅格式。请按照以下步骤与要素进行绘制。

##### 确定项目类型与目的
- 项目类型：Serverless 微服务脚本，部署在 Cloudflare Worker 或 Cloudflare Pages 平台上。
- 主要功能：
- 接收客户端 HTTP 请求（带 UUID、KEY、参数等）
- 根据环境变量或 KV 中的配置，调用不同的“订阅生成器”或“地址 API”
- 将原始 VLESS 信息组装并编码成 Base64/Sub/Clash/Singbox 格式响应给客户端

##### 分析文件结构与核心组件
- 顶层文件：
- `_worker.js`：主脚本，处理 HTTP 请求、参数解析、调用外部 API、组装响应
- `明文源码.js`：可能是未经混淆的原始版本，阅读参考
- CI/CD：
- `.github/workflows/obfuscator.yml`：脚本混淆打包流程
- `.github/workflows/sync.yml`：同步或发布到 Pages 的流程
- 配置来源：
- Cloudflare Worker 环境变量（UUID、KEY、SUB、SUBAPI、ADD*、TIME等）
- 可选绑定的 KV 命名空间（变量 `KV`），用于在线编辑 ADD 列表

##### 核心系统组件与交互
a. 客户端（用户、自动化工具）
- 发起 HTTP 请求，格式如：
https://{worker-url}/{UUID}[?sub=&proxyip=&…]
b. CDN 边缘（Cloudflare）
- 请求首先落到 Cloudflare CDN，缓存静态内容或触发 Worker
c. Cloudflare Worker / Pages 运行时
- 执行 `_worker.js`：
1) 参数解析（UUID vs KEY、TIME、格式参数）
2) 环境变量与 KV（如绑定了 `KV`）读取配置
3) 根据 `SUB` 或 `ADD*` 决定调用：
- 外部订阅生成器 API（`SUBAPI`）
- 本地 ADD 或 ADDAPI（地址列表 API）
4) 组装 VLESS 节点信息，按请求格式（Base64、Clash、Singbox）编码
5) 返回 HTTP 响应
d. 外部服务
- 订阅转换后端（SUBAPI 域名）
- 地址列表 API（ADDAPI）
- （可选）Telegram 通知机器人 API

##### 绘制架构图要点
a. 组件区分
- 用矩形/图标分别表示：
- Client（浏览器/工具）
- Cloudflare CDN/Edge
- Worker 服务（包含环境变量 + KV）
- External API 服务（SUBAPI、ADDAPI、Telegram Bot）
b. 数据流与依赖
- 从 Client 到 CDN（箭头）
- CDN 到 Worker（箭头）
- Worker 到 KV/Env（双向或读取箭头）
- Worker 到 External API（箭头）
- Worker 返回给 Client（箭头）
c. 关键技术与设计原则
- Serverless 架构：无持久化数据库，仅靠 KV 和外部 API
- 环境变量驱动：UUID/KEY、SUB/SUBAPI、ADD/API 等通过环境变量注入
- 可选扩展点：KV 命名空间用于在线编辑列表
d. 颜色/形状区分
- 前端请求流（蓝色箭头）
- 边缘/CDN（浅灰背景）
- Serverless 执行层（绿色矩形）
- 环境变量/KV（黄色小图标）
- 外部服务（橙色矩形）

##### 针对“edgetunnel”项目的具体标注
- 在 Worker 节点内，标出 `_worker.js` 逻辑模块：
- Request Parser
- Config Loader（Env + KV）
- Converter（VLESS→订阅）
- HTTP Responder
- 标注常用环境变量：UUID/KEY、SUB、SUBAPI、ADDAPI、TIME、KV
- 标出两种部署模式：CF Worker vs CF Pages（相同脚本，不同触发器）
- 若使用 KV，额外绘制一个 KV 存储组件，并注明“环境变量 KV 绑定”

##### 图示规范（必备）
- 每个组件清晰标注名称与职责
- 箭头表明调用顺序与数据流向
- 颜色/形状区分边缘/CDN、执行层、存储、外部服务

如此即可得到一份既反映“edgetunnel”Serverless 架构特点，又充分展示脚本内部流程与外部依赖的系统设计图。务必详细标注每个模块、交互与配置来源，确保读者一眼看懂整体执行链路与扩展点。

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph "Client Layer"
        direction TB
        Client["Client (Browser/Tool)"]:::frontend
    end

    %% CDN / Edge Layer
    subgraph "Cloudflare CDN/Edge"
        direction TB
        CDN["Cloudflare CDN/Edge"]:::edge
    end

    %% Serverless Execution Layer
    subgraph "Serverless Execution Layer"
        direction TB
        WorkerScript["_worker.js<br/>(Main Worker Script)"]:::serverless
        Parser["Request Parser"]:::serverless
        ConfigLoader["Config Loader<br/>(Env & KV)"]:::serverless
        Converter["Converter<br/>(VLESS→Subscriptions)"]:::serverless
        Responder["HTTP Responder"]:::serverless
        Env["Environment Variables"]:::storage
        KV["KV Namespace"]:::storage
    end

    %% External Services
    subgraph "External Services"
        direction TB
        SUBAPI["Subscription Generator API"]:::external
        ADDAPI["Address List API"]:::external
        Telegram["Telegram Bot API"]:::external
    end

    %% Project Files & CI/CD
    subgraph "Project Files & CI/CD"
        direction TB
        Unobf["明文源码.js"]:::code
        Obfuscator[".github/workflows/obfuscator.yml"]:::code
        Sync[".github/workflows/sync.yml"]:::code
        README["README.md"]:::code
        LICENSE["LICENSE"]:::code
    end

    %% Data Flows
    Client -->|"HTTP Request"| CDN
    CDN -->|"Trigger Worker"| WorkerScript
    WorkerScript --> Parser
    Parser --> ConfigLoader
    ConfigLoader --> Converter
    Converter --> Responder
    Responder -->|"HTTP Response"| CDN
    CDN --> Client

    ConfigLoader -->|"reads"| Env
    ConfigLoader -->|"reads"| KV

    Converter -->|"calls"| SUBAPI
    Converter -->|"calls"| ADDAPI
    Converter -->|"notifies"| Telegram

    %% Click Events
    click WorkerScript "https://github.com/cmliu/edgetunnel/blob/main/_worker.js"
    click Unobf "https://github.com/cmliu/edgetunnel/blob/main/明文源码.js"
    click Obfuscator "https://github.com/cmliu/edgetunnel/blob/main/.github/workflows/obfuscator.yml"
    click Sync "https://github.com/cmliu/edgetunnel/blob/main/.github/workflows/sync.yml"
    click README "https://github.com/cmliu/edgetunnel/blob/main/README.md"
    click LICENSE "https://github.com/cmliu/edgetunnel/tree/main/LICENSE"

    %% Styles
    classDef frontend fill:#E3F2FD,stroke:#90CAF9,color:#0D47A1
    classDef edge fill:#F5F5F5,stroke:#BDBDBD,color:#424242
    classDef serverless fill:#E8F5E9,stroke:#66BB6A,color:#1B5E20
    classDef storage fill:#FFF9C4,stroke:#FFEE58,color:#F57F17
    classDef external fill:#FFE0B2,stroke:#FFA726,color:#E65100
    classDef code fill:#ECEFF1,stroke:#90A4AE,color:#37474F,stroke-dasharray: 2 2
```
