nite/sub2clash
1
0
Fork 0
mirror of https://github.com/nitezs/sub2clash.git synced 2024-12-23 14:44:42 -05:00
Code Projects Activity
将节点和订阅转换为 clash(meta) 配置
33 Commits 1 Branch 15 Tags 718 KiB
Go 84.9%
JavaScript 9.7%
HTML 5.2%
Dockerfile 0.2%
f166c6a54a
Go to file
nitezs f166c6a54a fix
2023-09-17 17:24:30 +08:00
.github/workflows Update go.yml 2023-09-15 10:47:23 +08:00
api fix 2023-09-17 16:59:02 +08:00
config fix 2023-09-17 17:02:59 +08:00
logger update 2023-09-13 13:47:22 +08:00
middleware update 2023-09-13 13:47:22 +08:00
model feat: 增加短链生成 2023-09-17 15:52:37 +08:00
parser fix: 修复只提供节点链接时空指针的问题 2023-09-17 13:21:01 +08:00
templates feat: Web UI 2023-09-17 10:36:40 +08:00
utils update: 使用glebarez/sqlite替代gorm.io/driver/sqlite实现无需CGO运行 2023-09-17 16:14:31 +08:00
validator feat: 增加短链生成 2023-09-17 15:52:37 +08:00
.env.example fix 2023-09-17 16:59:02 +08:00
.gitignore feat: 增加短链生成 2023-09-17 15:52:37 +08:00
.goreleaser.yaml fix 2023-09-17 10:46:49 +08:00
docker-compose.yml fix 2023-09-17 10:46:49 +08:00
Dockerfile fix: 修改 Dockerfile 工作目录 2023-09-15 09:15:24 +08:00
go.mod fix 2023-09-17 17:24:30 +08:00
go.sum fix 2023-09-17 17:24:30 +08:00
LICENSE.txt update 2023-09-13 00:46:17 +08:00
main.go feat: 增加短链生成 2023-09-17 15:52:37 +08:00
README.md fix 2023-09-17 16:59:02 +08:00

README.md

sub2clash

将订阅链接转换为 Clash、Clash.Meta 配置

特性

  • 开箱即用的规则、策略组配置
  • 自动根据节点名称按国家划分策略组
  • 支持多订阅合并
  • 支持多种协议
    • Shadowsocks
    • ShadowsocksR
    • Vmess
    • Vless
    • Trojan

使用

运行

配置

可以通过编辑 .env 文件来修改默认配置，docker 直接添加环境变量

变量名 说明 默认值
BASE_PATH 程序运行子路径，例如将服务反代在 https://example.com/sub 则此变量值应为 /sub /
PORT 端口 8011
META_TEMPLATE meta 模板文件名 template_meta.yaml
CLASH_TEMPLATE clash 模板文件名 template_clash.yaml
REQUEST_RETRY_TIMES Get 请求重试次数 3
REQUEST_MAX_FILE_SIZE Get 请求订阅文件最大大小（byte） 1048576
CACHE_EXPIRE 订阅缓存时间（秒） 300
LOG_LEVEL 日志等级，可选值 debug,info,warn,error info

API

/clash, /meta

获取 Clash/Clash.Meta 配置链接

Query 参数 类型 是否必须 默认值 说明
sub string sub/proxy 至少有一项存在 - 订阅链接（可以输入多个，用 , 分隔）
proxy string sub/proxy 至少有一项存在 - 节点分享链接（可以输入多个，用 , 分隔）
refresh bool 否 false 强制刷新配置（默认缓存 5 分钟）
template string 否 - 外部模板链接或内部模板名称
ruleProvider string 否 - 格式 [Behavior,Url,Group,Prepend,Name],[Behavior,Url,Group,Prepend,Name]...，其中 Group 是该规则集所走的策略组名，Prepend 为 bool 类型，如果为 true 规则将被添加到规则列表顶部，否则添加到规则列表底部（会调整到MATCH规则之前）
rule string 否 - 格式 [Rule,Prepend],[Rule,Prepend]...，其中 Prepend 为 bool 类型，如果为 true 规则将被添加到规则列表顶部，否则添加到规则列表底部（会调整到MATCH规则之前）
autoTest bool 否 false 国家策略组是否自动测速
lazy bool 否 false 自动测速是否启用 lazy
sort string 否 nameasc 国家策略组排序策略，可选值 nameasc、namedesc、sizeasc、sizedesc

默认模板

已知问题

代理链接解析还没有经过严格测试，可能会出现解析错误的情况，如果出现问题请提交 issue

TODO