🚀 快速开始

本地部署

• 从Release下载对应平台的工具包
• 解压打开，复制一份pref.example.toml为pref.toml
• 如果有需求，修改配置内容；如果需要私有化订阅，可以修改private_sub.toml，以及可以在file_share添加共享的文件
• 运行easysub可执行文件
• 调用api,例如 http://127.0.0.1:25500/sub?target=clash&url={替换为自己的节点用|分割多个}&config={替换为自己需要的配置}

Docker部署

• 编写自己的Dockerfile,可以参考docker_example目录
• 使用Docker构建该文件，或者放到github私有仓库中，使用容器服务商构建，例如railway和render

✨ 功能特点

支持协议

• ShadowSocks
• VMess
• VLESS
• Trojan

核心功能

• 兼容subconverter的sub api用法
• 自定义私有化订阅，对自建节点用户友好
• 支持file:///开头的本地共享文件，默认读取workdir/file_share。适合配合私有化订阅使用

客户端支持

• Sing-Box
• Clash

主要端点

• /sub - 生成订阅配置
• /p - 私有化订阅

api示例

sub 普通订阅模式(跟subconverter用法一致)

# clash订阅
http://127.0.0.1:25500/sub?target=clash&url=trojan://password@zxc.123456.xyz:443?ws=1&peer=zxc.123456.xyz&sni=zxc.123456.xyz#zxc.123456.xyz_trojan&config=https://raw.githubusercontent.com/ACL4SSR/ACL4SSR/refs/heads/master/Clash/config/ACL4SSR_Online_Mini_NoAuto.ini

#singbox订阅
http://127.0.0.1:25500/sub?target=singbox&url=trojan://password@zxc.123456.xyz:443?ws=1&peer=zxc.123456.xyz&sni=zxc.123456.xyz#zxc.123456.xyz_trojan&config=https://raw.githubusercontent.com/ACL4SSR/ACL4SSR/refs/heads/master/Clash/config/ACL4SSR_Online_Mini_NoAuto.ini

p 私有化订阅方式

先配置和修改private_sub.toml,可以参考本项目workdir下的文件，里面配置好了一些示例节点和url重写

调用api使用

# clash订阅，其中112233是随便配置的密钥
# 节点是配置在private_sub.toml中，相当于rewrite了请求url
http://127.0.0.1:25500/p/clash/112233

# singbox订阅，同上
http://127.0.0.1:25500/p/singbox/112233

🤝 贡献

欢迎提交 Issues 和 Pull Requests 来改进这个项目。