Repository: tindy2013/subconverter

Stars: 16365

README.md Copy Chapter

subconverter

Utility to convert between various proxy subscription formats.


Docker README

中文文档

- subconverter
- Supported Types
- Quick Usage
- Access Interface
- Description
- Advanced Usage
- Auto Upload

Supported Types Copy Chapter

| Type | As Source | As Target | Target Name |
| ------------ | :--------: | :----------: | ----------- |
| Clash | ✓ | ✓ | clash |
| ClashR | ✓ | ✓ | clashr |
| Quantumult | ✓ | ✓ | quan |
| Quantumult X | ✓ | ✓ | quanx |
| Loon | ✓ | ✓ | loon |
| SS (SIP002) | ✓ | ✓ | ss |
| SS Android | ✓ | ✓ | sssub |
| SSD | ✓ | ✓ | ssd |
| SSR | ✓ | ✓ | ssr |
| Surfboard | ✓ | ✓ | surfboard |
| Surge 2 | ✓ | ✓ | surge&ver=2 |
| Surge 3 | ✓ | ✓ | surge&ver=3 |
| Surge 4 | ✓ | ✓ | surge&ver=4 |
| V2Ray | ✓ | ✓ | v2ray |
| Telegram-liked HTTP/Socks 5 links | ✓ | × | Only as source |

Notice:

1. Shadowrocket users should use ss, ssr or v2ray as target.

2. You can add &remark= to Telegram-liked HTTP/Socks 5 links to set a remark for this node. For example:

- tg://http?server=1.2.3.4&port=233&user=user&pass=pass&remark=Example

- https://t.me/http?server=1.2.3.4&port=233&user=user&pass=pass&remark=Example

---

Quick Usage Copy Chapter

Using default groups and rulesets configuration directly, without changing any settings

Access Interface Copy Section

http://127.0.0.1:25500/sub?target=%TARGET%&url=%URL%&config=%CONFIG%

Description Copy Section

| Argument | Required | Example | Description |
| -------- | :------: | :------ | ----------- |
| target | Yes | clash | Target subscription type. Acquire from Target Name in Supported Types. |
| url | Yes | https%3A%2F%2Fwww.xxx.com | Subscription to convert. Supports URLs and file paths. Process with URLEncode first. |
| config | No | https%3A%2F%2Fwww.xxx.com | External configuration file path. Supports URLs and file paths. Process with URLEncode first. More examples can be found in this repository. |

If you need to merge two or more subscription, you should join them with '|' before the URLEncode process.

Example:

You have 2 subscriptions and you want to merge them and generate a Clash subscription:
1. https://dler.cloud/subscribe/ABCDE?clash=vmess
2. https://rich.cloud/subscribe/ABCDE?clash=vmess
First use '|' to separate 2 subscriptions:
https://dler.cloud/subscribe/ABCDE?clash=vmess|https://rich.cloud/subscribe/ABCDE?clash=vmess
Then process it with URLEncode to get %URL%:
https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess%7Chttps%3A%2F%2Frich.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess
Then fill %TARGET% and %URL% in Access Interface with actual values:
http://127.0.0.1:25500/sub?target=clash&url=https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess%7Chttps%3A%2F%2Frich.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess
Finally subscribe this link in Clash and you are done!

---

Advanced Usage Copy Chapter

Please refer to 中文文档.

Auto Upload Copy Chapter

Upload Gist automatically

Add a Personal Access Token into gistconf.ini in the root directory, then add &upload=true to the local subscription link, then when you access this link, the program will automatically update the content to Gist repository.

Example:

[common]
;uncomment the following line and enter your token to enable upload function
token = xxxxxxxxxxxxxxxxxxxxxxxx(Your Personal Access Token)