2023-09-12 06:40:24 -04:00
|
|
|
|
# sub2clash
|
|
|
|
|
|
|
|
|
|
将订阅链接转换为 Clash、Clash.Meta 配置
|
|
|
|
|
|
|
|
|
|
## 特性
|
|
|
|
|
|
2023-09-12 12:46:17 -04:00
|
|
|
|
- 开箱即用的规则、策略组配置
|
|
|
|
|
- 自动根据节点名称按国家划分策略组
|
|
|
|
|
- 支持多订阅合并
|
|
|
|
|
- 支持多种协议
|
2023-09-14 05:59:17 -04:00
|
|
|
|
- Shadowsocks
|
|
|
|
|
- ShadowsocksR
|
|
|
|
|
- Vmess
|
|
|
|
|
- Vless
|
|
|
|
|
- Trojan
|
|
|
|
|
|
|
|
|
|
## 使用
|
|
|
|
|
|
|
|
|
|
### 运行
|
|
|
|
|
|
|
|
|
|
- [docker compose](./docker-compose.yml)
|
|
|
|
|
- 运行[二进制文件](./releases/latest)
|
|
|
|
|
|
|
|
|
|
### 配置
|
|
|
|
|
|
|
|
|
|
可以通过编辑 .env 文件来修改默认配置,docker 直接添加环境变量
|
|
|
|
|
|
|
|
|
|
| 变量名 | 说明 | 默认值 |
|
|
|
|
|
|-----------------------|----------------------------------------|-----------------------|
|
|
|
|
|
| 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`
|
2023-09-12 06:40:24 -04:00
|
|
|
|
|
2023-09-13 01:47:22 -04:00
|
|
|
|
获取 Clash/Clash.Meta 配置链接
|
2023-09-12 06:40:24 -04:00
|
|
|
|
|
2023-09-13 01:47:22 -04:00
|
|
|
|
| Query 参数 | 类型 | 是否必须 | 说明 |
|
|
|
|
|
|--------------|--------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| sub | string | sub/proxy 至少有一项存在 | 订阅链接(可以输入多个,用 `,` 分隔) |
|
|
|
|
|
| proxy | string | sub/proxy 至少有一项存在 | 节点分享链接(可以输入多个,用 `,` 分隔) |
|
|
|
|
|
| refresh | bool | 否(默认 `false`) | 强制刷新配置(默认缓存 5 分钟) |
|
|
|
|
|
| template | string | 否 | 外部模板 |
|
|
|
|
|
| ruleProvider | string | 否 | 格式 `[Behavior,Url,Group,Prepend],[Behavior,Url,Group,Prepend],...`,其中 `Group` 是该规则集所走的策略组名,`Prepend` 为 bool 类型,如果为 `true` 规则将被添加到规则列表顶部,否则添加到规则列表底部(会调整到MATCH规则之前) |
|
|
|
|
|
| rule | string | 否 | 格式 `[Rule,Prepend],[Rule,Prepend]...`,其中 `Prepend` 为 bool 类型,如果为 `true` 规则将被添加到规则列表顶部,否则添加到规则列表底部(会调整到MATCH规则之前) |
|
|
|
|
|
| autoTest | bool | 否(默认 `false`) | 指定国家策略组是否自动测速 |
|
|
|
|
|
| lazy | bool | 否(默认 `false`) | 自动测速是否启用 lazy |
|
2023-09-12 06:40:24 -04:00
|
|
|
|
|
2023-09-13 01:47:22 -04:00
|
|
|
|
## 默认模板
|
2023-09-12 06:40:24 -04:00
|
|
|
|
|
2023-09-13 01:47:22 -04:00
|
|
|
|
- [Clash](./templates/template_clash.yaml)
|
|
|
|
|
- [Clash.Meta](./templates/template_meta.yaml)
|
2023-09-12 06:40:24 -04:00
|
|
|
|
|
2023-09-13 01:47:22 -04:00
|
|
|
|
## 已知问题
|
|
|
|
|
|
|
|
|
|
[代理链接解析](./parser)还没有经过严格测试,可能会出现解析错误的情况,如果出现问题请提交 issue
|
2023-09-12 12:46:17 -04:00
|
|
|
|
|
|
|
|
|
## TODO
|
|
|
|
|
|