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)
|
2023-09-14 06:02:04 -04:00
|
|
|
|
- 运行[二进制文件](https://github.com/nitezs/sub2clash/releases/latest)
|
2023-09-14 05:59:17 -04:00
|
|
|
|
|
|
|
|
|
### 配置
|
|
|
|
|
|
|
|
|
|
可以通过编辑 .env 文件来修改默认配置,docker 直接添加环境变量
|
|
|
|
|
|
2023-09-17 04:59:02 -04:00
|
|
|
|
| 变量名 | 说明 | 默认值 |
|
|
|
|
|
|-----------------------|-----------------------------------------------------------|-----------------------|
|
|
|
|
|
| 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` |
|
2023-09-20 21:08:02 -04:00
|
|
|
|
| SHORT_LINK_LENGTH | 短链长度 | `6` |
|
2023-09-14 05:59:17 -04:00
|
|
|
|
|
|
|
|
|
### API
|
|
|
|
|
|
2023-09-22 11:43:26 -04:00
|
|
|
|
[API文档](./API_README.md)
|
2023-09-12 06:40:24 -04:00
|
|
|
|
|
2023-09-22 11:43:26 -04:00
|
|
|
|
### 模板
|
2023-09-12 06:40:24 -04:00
|
|
|
|
|
2023-09-25 03:43:21 -04:00
|
|
|
|
可以通过变量自定义模板中的策略组代理节点
|
2023-09-22 11:43:26 -04:00
|
|
|
|
解释的不太清楚,可以参考下方默认模板
|
2023-09-12 06:40:24 -04:00
|
|
|
|
|
2023-09-22 11:43:26 -04:00
|
|
|
|
- `<all>` 为添加所有节点
|
|
|
|
|
- `<countries>` 为添加所有国家策略组
|
|
|
|
|
|
|
|
|
|
#### 默认模板
|
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
|