Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Toperlock committed Mar 18, 2024
1 parent 0a91d3f commit 6ce5e26
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 15 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,25 @@

### 使用 `/config/URL` 添加参数符号已修改,从原来的 `/&` 改为 `&`。有问题请提issue,不要打扰 `sing-box`

### 请使用 `/config/URL` 时添加任何参数不要在第一个`&`,加上 `/`,我已经取消适配这种错误的写法
```
https://xxxxxxx.vercel.app/config/https://xxxxxxsubscribe?token=123456&file=https://github.com/Toperlock/sing-box-subscribe/raw/main/config_template/config_template_groups_rule_set_tun.json
```

```
https://xxxxxxx.vercel.app/config/https://xxxxxxsubscribe?token=123456&file=2
```

### sing-box 1.8.0+ 已发布,配置需要修改。已上传rule_set模板,并且默认生成最新配置文件适配 sing-box 1.8.0。~~用旧版singbox请选择`config_template_groups_tun.json`模板~~(已删除旧版配置模板)
本地python执行脚本命令:

### 使用 `/config/URL` 可以后面添加 `&file=2` 参数选择 `config_template_groups_v6_rule_set_tun` 模板。两条订阅的形式也可以后面加 `&file=2` 参数
```
python main.py
```

或者你可以直接带template_index参数选定模板,0表示第一个模板

```
python main.py --template_index=0
```

### 根据已有的qx,surge,loon,clash规则列表自定义规则集[https://github.com/Toperlock/sing-box-geosite](https://github.com/Toperlock/sing-box-geosite)

Expand Down
17 changes: 5 additions & 12 deletions instructions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ For example, the website I built [https://sing-box-subscribe.vercel.app](https:/
https://xxxxxxx.vercel.app/config/https://xxxxxxsubscribe?token=123456&file=https://github.com/Toperlock/sing-box-subscribe/raw/main/config_template/config_template_groups_rule_set_tun.json
```

### 2023.10.26 Update: Support adding `emoji`, `tag`, `prefix`, `ua`, `file` parameters after the link. Use `&` to connect multiple parameters. The usage is the same as the parameters in `providers.json`
### 2024.2.16 Update: Support adding `emoji`, `tag`, `prefix`, `ua`, `file`, `eps` parameters after the link. Use `&` to connect multiple parameters. The usage is the same as the parameters in `providers.json`

`/config/URL_LINK&emoji=1&prefix=♥&ua=v2rayng&file=https://xxxxxxxxx.json`
`/config/URL_LINK&emoji=1&prefix=♥&ua=v2rayng&eps=vmess,hy2&file=https://xxxxxxxxx.json`

The above example shows: enable emoji, add ♥ before the node name, use v2rayng user agent, and use `https://xxxxxxxxx.json` as the generated sing-box configuration template

Expand All @@ -44,10 +44,6 @@ Example: https://sing-box-subscribe.vercel.app/config/https%3A%2F%2Fgist.githubu

Example: https://sing-box-subscribe.vercel.app/config/https://gist.githubusercontent.com/Toperlock/b1ca381c32820e8c79669cbbd85b68ac/raw/dafae92fbe48ff36dae6e5172caa1cfd7914cda4/gistfile1.txt&file=2

### 2023.11.30 Update: sing-box 1.8.0+ has been released, the configuration needs to be modified. The `rule_set` template has been uploaded, and the latest configuration file is generated by default to adapt to sing-box 1.8.0. If you use the old version of sing-box, ~~please choose the `config_template_groups_tun.json` template~~.(Configurations below version 1.8 have been cancelled.)

Use `/config/URL` to add the `&file=2` parameter to select the `config_template_groups_v6_rule_set_tun.json` template. The form of two sublinks can also be followed by the `&file=2` parameter.

### Demo video

|Web parsing subscription link(v2/clash/sing-box)|
Expand Down Expand Up @@ -150,7 +146,7 @@ Android use chrome browser to open the webpage to generate the configuration fil
### In the terminal, input the following command to install dependencies (on Mac, replace `pip` with `pip3`):

```
pip install requests paramiko scp chardet Flask PyYAML ruamel.yaml
pip install -r requirements.txt
```

<div align="left">
Expand All @@ -169,14 +165,11 @@ pip install requests paramiko scp chardet Flask PyYAML ruamel.yaml
python main.py
```

### If you receive module-related errors while using the script, install the corresponding modules using the command provided below (on Mac, replace `pip` with `pip3`):
or you can directly select the template with the `template_index`, `0` means the first template

```
pip install chardet
python main.py --template_index=0
```
<div align="left">
<img src="https://github.com/Toperlock/sing-box-subscribe/assets/86833913/1762db84-23f5-4cbd-a9d1-df3ca253396c" alt="install" width="60%" />
</div>

For Windows systems, it's recommended to add the commands to a batch program for execution.

Expand Down

0 comments on commit 6ce5e26

Please sign in to comment.