mirror of
https://github.com/bestnite/sub2clash.git
synced 2025-06-17 12:43:18 +08:00
add:goreleaser.yaml
mod:docker.yml mod:go.yml mod:docker-compose.yml mod:README.md
This commit is contained in:
46
README.md
46
README.md
@ -8,32 +8,36 @@
|
||||
- 自动根据节点名称按国家划分策略组
|
||||
- 支持多订阅合并
|
||||
- 支持多种协议
|
||||
- [x] Shadowsocks
|
||||
- [x] ShadowsocksR
|
||||
- [x] Vmess
|
||||
- [x] Vless
|
||||
- [x] Trojan
|
||||
- [ ] Hysteria
|
||||
- [ ] TUIC
|
||||
- [ ] WireGuard
|
||||
- Shadowsocks
|
||||
- ShadowsocksR
|
||||
- Vmess
|
||||
- Vless
|
||||
- Trojan
|
||||
|
||||
## 配置
|
||||
## 使用
|
||||
|
||||
可以通过编辑 .env 文件来修改默认配置
|
||||
### 运行
|
||||
|
||||
| 变量名 | 说明 |
|
||||
|-----------------------|--------------------------------------------------|
|
||||
| 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` |
|
||||
- [docker compose](./docker-compose.yml)
|
||||
- 运行[二进制文件](./releases/latest)
|
||||
|
||||
## API
|
||||
### 配置
|
||||
|
||||
### `/clash`,`/meta`
|
||||
可以通过编辑 .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`
|
||||
|
||||
获取 Clash/Clash.Meta 配置链接
|
||||
|
||||
|
Reference in New Issue
Block a user