edgetunnel README

The project's README from github.com/cmliu/edgetunnel. As one markdown file: README.md.

🚀 edgetunnel 2.1

后台页面

Stars Forks License Telegram YouTube zread Ask DeepWiki

📖 项目简介

edgetunnel 是一个基于 CF Workers/Pages 平台的边缘计算隧道解密方案。它能够高效地处理网络流量，并提供强大的管理面板和灵活的节点配置能力。

✨ 核心特性

💡 快速部署

[!TIP] 📖 详尽图文教程：edgetunnel 部署指南

[!WARNING] ⚠️ Error 1101问题：视频解析

⚙️ Workers 部署

「 Workers 部署文字教程 」

  1. 部署 CF Worker：

    • 在 CF Worker 控制台中创建一个新的 Worker。
    • 将 worker.js 的内容粘贴到 Worker 编辑器中。
    • 在左侧的 设置选项卡中，选择 变量 > 添加变量。 变量名称填写ADMIN，值则为你的管理员密码，后点击 保存即可。

  2. 绑定 KV 命名空间：

    • 在 绑定选项卡中选择 添加绑定 + > KV 命名空间 > 添加绑定，然后选择一个已有的命名空间或创建一个新的命名空间进行绑定。
    • 变量名称填写KV，然后点击 添加绑定即可。

  3. 给 Workers绑定 自定义域：

    • 在 workers控制台的 触发器选项卡，下方点击 添加自定义域。
    • 填入你已转入 CF 域名解析服务的次级域名，例如:vless.google.com后 点击添加自定义域，等待证书生效即可。

  4. 访问后台：

    • 访问 https://vless.google.com/admin 输入管理员密码即可登录后台。

🛠 Pages 上传 部署方法 最佳推荐!!! 图文教程

「 Pages 上传文件部署文字教程 」

  1. 部署 CF Pages：

    • 下载 main.zip 文件，并点上 Star !!!
    • 在 CF Pages 控制台中选择 上传资产后，为你的项目取名后点击 创建项目，然后上传你下载好的 main.zip 文件后点击 部署站点。
    • 部署完成后点击 继续处理站点 后，选择 设置 > 环境变量 > 制作为生产环境定义变量 > 添加变量。 变量名称填写ADMIN，值则为你的管理员密码，后点击 保存即可。
    • 返回 部署 选项卡，在右下角点击 创建新部署 后，重新上传 main.zip 文件后点击 保存并部署 即可。

  2. 绑定 KV 命名空间：

    • 在 设置选项卡中选择 绑定 > + 添加 > KV 命名空间，然后选择一个已有的命名空间或创建一个新的命名空间进行绑定。
    • 变量名称填写KV，然后点击 保存后重试部署即可。

  3. 给 Pages绑定 CNAME自定义域：视频教程

    • 在 Pages控制台的 自定义域选项卡，下方点击 设置自定义域。
    • 填入你的自定义次级域名，注意不要使用你的根域名，例如： 您分配到的域名是 fuck.cloudns.biz，则添加自定义域填入 lizi.fuck.cloudns.biz即可；
    • 按照 CF 的要求将返回你的域名DNS服务商，添加 该自定义域 lizi的 CNAME记录 edgetunnel.pages.dev 后，点击 激活域即可。

  4. 访问后台：

    • 访问 https://lizi.fuck.cloudns.biz/admin 输入管理员密码即可登录后台。

🛠 Pages + GitHub 部署方法

「 Pages + GitHub 部署文字教程 」

  1. 部署 CF Pages：

    • 在 Github 上先 Fork 本项目，并点上 Star !!!
    • 在 CF Pages 控制台中选择 连接到 Git后，选中 edgetunnel项目后点击 开始设置。
    • 在 设置构建和部署页面下方，选择 环境变量（高级）后并 添加变量 变量名称填写ADMIN，值则为你的管理员密码，后点击 保存并部署即可。

  2. 绑定 KV 命名空间：

    • 在 设置选项卡中选择 绑定 > + 添加 > KV 命名空间，然后选择一个已有的命名空间或创建一个新的命名空间进行绑定。
    • 变量名称填写KV，然后点击 保存后重试部署即可。

  3. 给 Pages绑定 CNAME自定义域：视频教程

    • 在 Pages控制台的 自定义域选项卡，下方点击 设置自定义域。
    • 填入你的自定义次级域名，注意不要使用你的根域名，例如： 您分配到的域名是 fuck.cloudns.biz，则添加自定义域填入 lizi.fuck.cloudns.biz即可；
    • 按照 CF 的要求将返回你的域名DNS服务商，添加 该自定义域 lizi的 CNAME记录 edgetunnel.pages.dev 后，点击 激活域即可。

  4. 访问后台：

    • 访问 https://lizi.fuck.cloudns.biz/admin 输入管理员密码即可登录后台。

🔑 环境变量说明

变量名 必填 示例 详细备注
ADMIN ✅ 123456 后台管理面板登录密码
KEY ❌ CMLiussss 快速订阅路径密钥，访问 /CMLiussss 即可快速获取节点
UUID ❌ 90cd4a77-141a-43c9-991b-08263cfe9c10 强制固定UUID，只支持UUIDv4标准格式
PROXYIP ❌ proxyip.cmliussss.net:443 全局自定义反代 IP
URL ❌ https://cloudflare-error-page-3th.pages.dev 默认主页伪装地址（可填写网页 URL 或 1101）
GO2SOCKS5 ❌ blog.cmliussss.com,*.ip111.cn,*google.com 强制走 SOCKS5 的名单 (* 为全局，域名用逗号分隔)
DEBUG ❌ 1或true 开发者模式，默认关闭调试日志功能（console.log），设置1或true则开启调试日志功能
OFF_LOG ❌ 1或true 默认开启KV日志记录功能，设置1或true则关闭日志记录功能
BEST_SUB ❌ 1或true 默认关闭作为优选订阅生成器的功能，设置1或true则开启该功能
PRELOAD_RACE_DIAL ❌ 1或true 默认关闭作为预加载竞速拨号的功能，设置1或true则开启该功能
TCP_CONCURRENT_DIAL ❌ 2 TCP 并发拨号数，默认值为2；设置后不再根据中国移动网络自动降为单路
PROXY_CONCURRENT_DIAL ❌ 1 反代并发拨号数，默认值为1；数值越高连接速度越快，但 IP 切换也越频繁

🔧 高级实用技巧

如需修改 订阅地址里的TOKEN 和 用于节点验证的UUID ，可通过修改变量

  1. 修改ADMIN或KEY变量的值，可以随机修改 订阅地址里的TOKEN 和 用于节点验证的UUID
  2. 设置UUID变量可以强制固定 订阅地址里的TOKEN 和 用于节点验证的UUID，注意必须是UUIDv4标准格式，否则会导致节点无法使用。

本工具支持通过 PATH路径 动态切换底层代理方案：

💻 客户端适配情况

平台 推荐客户端
Windows v2rayN、Hiddify、FlClash、mihomo-party、Clash Verge Rev、Clashmi、FlyClash、Karing、Bettbox
Android v2rayNG、ClashMetaForAndroid、FlClash、Clashmi、Hiddify、NekoBox、FlyClash、Karing、Bettbox
iOS Surge、Shadowrocket、Stash、Hiddify、Loon、Egern、Clashmi、Karing、Quantumult X
macOS FlClash、mihomo-party、Clash Verge Rev、Surge、Clashmi、Karing、FlyClash
鸿蒙 ClashBox

⭐ 项目热度

Stargazers over time

🙏 特别鸣谢

💖 赞助支持 - 提供云服务器维持订阅转换服务

🛠 开源代码引用

⚠️ 免责声明

  1. 本项目（"edgetunnel"）仅供教育、科学研究及个人安全测试之目的。
  2. 使用者在下载或使用本项目代码时，必须严格遵守所在地区的法律法规。
  3. 作者 cmliu 对任何滥用本项目代码导致的行为或后果均不承担任何责任。
  4. 本项目不对因使用代码引起的任何直接或间接损害负责。
  5. 建议在测试完成后 24 小时内删除本项目相关部署。

如果您觉得项目对您有帮助，请给一个 Star 🌟，这是对我最大的鼓励！

edgetunnel (cmliu/edgetunnel)

subscription
Searching Database…

47.7K ·GitHub
Edgetunnel
What is this?edgetunnel is a proxy service that runs on Cloudflare Workers or Pages: it serves VLESS, Trojan and Shadowsocks nodes from the edge, with a built-in admin panel and automatic subscription generation.
So is it an app I install, or something deployed to the cloud?It lives in the cloud: you deploy a single worker.js script to a Cloudflare Worker, or upload a main.zip bundle to Cloudflare Pages, and manage everything through a web admin panel.
What does getting it running involve?Deploy to Workers by pasting worker.js into the editor (or upload main.zip to Pages), set an ADMIN variable with your password, bind a KV namespace, attach a custom domain, then log into the panel.
What do I need to have before deploying?A Cloudflare account with a KV namespace for storing config and logs, plus your own subdomain on Cloudflare DNS for the custom domain binding — no server of your own is required.
Anything that can trip me up?If you pin the UUID variable it must be standard UUIDv4 or the nodes stop working; the README also keeps a dedicated note for fixing Error 1101 after deployment.
Which devices can I use it from?Windows, Android, iOS, macOS, HarmonyOS and soft-router firmware; recommended clients include v2rayN and Hiddify on desktop, Shadowrocket and Surge on iOS, v2rayNG on Android.
Is there a catch in the license or terms?Code is GPL-2.0, but the disclaimer limits it to education, research and personal security testing, requires obeying local laws, and asks you to delete the deployment within 24 hours of testing.
How do my devices actually get the node list?It has a built-in subscription system that generates links with conversion for mainstream clients like Clash, Sing-box and Surge; set the KEY variable and visiting that path (e.g. /CMLiussss) hands you the nodes.
Can I chain it through my own upstream proxies?Yes — you can set a global ProxyIP, use SOCKS5/HTTP chained proxies (with a GO2SOCKS5 domain list to force traffic through SOCKS5), switch schemes by URL path, and tune the concurrent dial counts.
Is this the original edgetunnel?No — it is a fork that continues zizifn/edgetunnel and also credits EDtunnel, cloudflare-worker-vless-ip and other open-source projects it draws on.
What are similar projects?BPB-Worker-Panel, clash, Open-Box, Cloudflare-vless-trojan, panda-vpn-pro, CFNext, v2rayfree, Xray-core
Which topics is it in?cloudflare-pages, surge, subscription, admin-panel, sing-box, xray, proxy-server, mihomo, vmess, vless, clash, trojan
Creator
cmliu
Size
23 MB
Stars
47.7K
Updated
CommitOct 08
Age
2y
Commits · 90 Days