subconverter Documentation

Technical Documentation: tindy2013/subconverter

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

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

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

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)

Overview (`base/rules/DivineEngine/Surge/Ruleset/Extra/Apple/README.md`) Copy Section

说明 Copy Chapter

Apple 已知域名均已收录于 China.list 中并作直连策略，如无确切目的不需要额外添加。

对于一些 Apple 被「墙」或者主动「墙」的服务如 App Store Preview、Moveis Trailers、查询外汇、国际航线的 Spotlight、维基百科查询的 Dictionary 均已收录于 Global.list 进行代理。

该目录只是一时兴起想做一些关于 Apple 各子域名具体作用的收录，所以一些分流文件如 TestFlight.list、FindMy.list 并没有实际意义。

另外，个人主观认为鉴于 Apple 在国内大体良好的 CDN 部署个人不建议对其进行代理，当然既然进到了这个目录可能 Apple 的某些服务在你所在地区堪忧，相比以前对于 Apple 整体域名全部代理，该目录收录的一些细分分流文件如 App Store 应用下载、系统更新的专项代理应该更适合你。

分流文件说明 Copy Section

Apple.list

是 Apple 服务的总体整理，如您想对 Apple 服务均进行代理可以使用该分流文件，需要注意的是建议放置于 Global.list 与 China.list 之间，因 Global.list 有 Apple 对于中国大陆不可用服务的代理行为，如您的 Apple 策略经常在使用直连时会导致 Global.list 中的规则失效。

其他

Apple.list 以外的分流文件基本用于代理策略，文件名极其内容已说明其主要作用，使用时至少放在 China.list 之前即可。

Overview (`base/rules/DivineEngine/Surge/Ruleset/Extra/Game/README.md`) Copy Section

使用说明 Copy Chapter

本目录下的分流最直接的使用方法就是引用后策略使用代理。

但仍然建议先试用 UsbEAm Hosts Editor 或 UsbEAm Consoles DNS。

如 Origin 的下载服务器 origin-a.akamaihd.net 使用合适的 hosts 后直连可跑满宽带，在遇到满意的 hosts 可加入到 Surge 的 [Host] 然后添加相应规则直连使用。

Overview (`base/rules/DivineEngine/Surge/Ruleset/Extra/Telegram/README.md`) Copy Section

说明 Copy Chapter

Telegram 的主分流文件 Telegram.list 已收录于 Global.list 中，如无确切目的不需要额外添加。

Telegram.list 用于专门想对 Telegram 服务进行指定服务器节点，以达到加速目的所用。

而至于其他三个分流文件：

• TelegramNL.list
• TelegramSG.list
• TelegramUS.list

则为更具体所用，是针对 Telegram 目前几大数据中心的更具体的分流，主要是给使用 Telegram 大文件传输，指定更为具体区域的服务器节点以达到加速目的所用。

Overview (`base/rules/DivineEngine/Surge/Ruleset/StreamingMedia/Region/README.md`) Copy Section

说明 Copy Chapter

可以使用本目录下的流媒体分流文件按区域分流。

但需要注意的是，如 YouTube、Netflix、Amazon Prime Video 这类覆盖地区广泛或没有进行区域限制的流媒体服务并不在其中。

--- METRICS ---

• Files Extracted: 5
• Estimated Token Budget: ~1585 tokens
• Canonical Reference: https://codewiki.google/github.com/tindy2013/subconverter