Sub-Store README

The project's README from github.com/sub-store-org/Sub-Store. As one markdown file: README.md.

Sub-Store

Sub-Store

Advanced Subscription Manager for QX, Loon, Surge, Stash, Egern and Shadowrocket

Build GitHub GitHub issues GitHub closed pull requests Size
sub-store-org%2FSub-Store | Trendshift Buy Me A Coffee 联系推广

MaruCode MaruCode 是一家偶尔做做慈善的小破站 API,自营号池,不搞充值营销套路,主要提供 Codex、Claude Code、GPT Image-2 等主流模型,支持 WebSocket 协议,明码标价(Codex 0.3x, CC 1.5x),透明汇率(1:1),新用户注册 送 2 刀 💰 生图工作台 🖼

📚 文档/DOC

sub.store Domain Safety Notice

Statement

⚠️ sub.store is only the domain used by module-script rewrite MitM rules. It is not a public domain owned by us.

Risk

If a request does not go through the rewrite, the data will be sent to the public sub.store service.

You can map sub.store to 127.0.0.1 or another local address to prevent accidental access to the public sub.store. However, ordinary users may still send requests to the public sub.store after switching or toggling configuration modules.

  1. It could, in theory, redirect users to a fake frontend. This is only a possibility and does not imply that the owner of sub.store would do this. Note: The official frontend is https://sub-store.vercel.app.
  2. It could receive user data from sub.store.

This creates a data leakage risk.

Plan

After listening to suggestions from the group, we will not switch to a new domain for now. Choosing a new domain is also awkward: it needs to be related, short, and unlikely to be registered by someone else, at least in the short term.

This notice is published only as an announcement. No changes will be made for now.

Example:

[Host]
sub.store = 127.0.0.1

CORS Allowlist

Sub-Store also supports a configurable browser CORS allowlist for the backend API. This does not change the module rewrite domain, but it limits which browser origins can read API responses through CORS.

Core functionalities:

  1. Conversion among various formats.
  2. Subscription formatting.
  3. Collect multiple subscriptions in one URL.
  4. Host and modify subscriptions/files

The following descriptions of features may not be updated in real-time. Please refer to the actual available features for accurate information.

1. Subscription Conversion

Supported Input Formats

本地节点怎么写/How To Write A Local Node

⚠️ Do not use Shadowrocket or NekoBox to export URI and then import it as input. The URIs exported in this way may not be standard URIs. However, we have already supported some very common non-standard URIs (such as VMess, VLESS).

Deprecated(The frontend doesn't show it, but the backend still supports it, with the query parameter target=Clash):

Supported Target Platforms

Deprecated:

2. Subscription Formatting

Filtering

Proxy Operations

Development

Install pnpm

Go to backend directories, install node dependencies:

pnpm i
SUB_STORE_BACKEND_API_PORT=3000 pnpm esbuild:dev

or this one if you're using Termux

SUB_STORE_BACKEND_API_PORT=3000 pnpm run --parallel "/^dev:.*/"

Build

pnpm bundle:esbuild

LICENSE

This project is under the AGPL-3.0 LICENSE.

FOSSA Status

Star History

Star History

Acknowledgements

Sponsors

image

NodeSupport sponsored this project.

致谢

感谢赞助商 ForZTN 对项目服务器的支持,感谢。

Sub-Store (sub-store-org/Sub-Store)

Searching Database…

10.7K ·GitHub
What is this?Sub-Store is an advanced subscription manager for proxy apps like Quantumult X, Loon, Surge, Stash, Egern and Shadowrocket: it converts subscriptions between formats and manages your node lists.
Is this an app on my phone, or something I host myself?It runs as script modules inside your proxy app via MitM rewrite rules, or as a self-hosted Node.js backend with a separate web frontend.
How do I get it running?For a self-built setup the README says: install pnpm, go to the backend directories and install node dependencies — there is also an alternative install command for Termux on Android.
Is the sub.store domain safe? I saw a big warning about it.sub.store is only the domain used by module-script rewrite MitM rules, not owned by the team. A request that bypasses the rewrite reaches the public service, risking data leakage — mapping sub.store to 127.0.0.1 prevents that.
Can other websites read my subscription data through the browser?You can lock this down with the CORS allowlist: Node and server deployments set SUBSTORECORSALLOWEDORIGINS, proxy-app modules use the cors module argument, and origins are matched exactly by scheme, host and port.
Which proxy formats can it read as input?URI schemes for SS, SSR, VMess, VLESS, Trojan, Hysteria, Hysteria 2, TUIC v5, WireGuard, AnyTLS and SOCKS, plus Clash YAML and QX, Loon, Surge and mihomo configs. Plain HTTP(S) proxy URIs are not supported since they have no standard format, and URIs exported from Shadowrocket or NekoBox may be non-standard (common ones like VMess and VLESS are still accepted).
Which apps can it convert my subscription to?Plain JSON, Stash, Clash.Meta (mihomo), Surfboard, Surge, SurgeMac, Loon, Egern, Shadowrocket, Quantumult X, sing-box and V2Ray; the old Clash target still works through the target=Clash query parameter.
Can I merge several subscriptions into one link?Yes — collecting multiple subscriptions into a single URL is one of Sub-Store's core features, alongside format conversion and hosting your own subscription files.
Can it clean up or rename the nodes in my subscription?Yes. It has regex, region, type and script filters plus a useless-proxies filter, and operators to rename, sort or delete nodes by regex, add or remove country flags, set properties like udp or skip-cert-verify, and resolve node domains to IPs.
Size
15.9 MB
Stars
10.7K
Age
6y
Commits · 90 Days