Sub-Store 文档

安装 ​

Sub-Store 有多种部署方式，大部分由社区维护：

高级功能

高级功能（HTTP-META / 推送通知 / MMDB 本地数据库）对 Docker 自建、Android 模块版以及需要定时推送/本地测活的部署可用；客户端内置版（Clash Party / Sparkle / SubCase）大多无法直接使用，可忽略。详情见 高级功能。

方式说明注意
软件内置Clash Party / Sparkle 等客户端内置了 Sub-Store大多无法直接使用高级功能
代理 App 模块Surge / Shadowrocket / Loon / QX 等可以变通使用部分高级功能
Android 模块Delusions6515/Sub-Store-Module需要 root
可以直接使用高级功能
Android APPsub-store-org/subcase无法直接使用高级功能
Android Termux社区维护：Termux 安装教程
Docker 自建官方镜像 xream/sub-store若要使用高级功能，请参考 Docker Hub 页面说明
官方前端https://sub-store.vercel.app仅前端，需搭配自定义后端使用

软件内置 ​

Clash Party / xishang0128/Sparkle 等客户端内置了 Sub-Store 支持

在客户端内点击右上角下载按钮即可更新内置的 Sub-Store。

代理 App 版 ​

Sub-Store 提供各代理 App 的模块/插件/重写配置，位于后端仓库的 config 目录。各应用安装后，用 Safari 打开 https://sub.store 确认能正常打开（无错误提示）即配置成功；也可以把前端添加到主屏幕，获得类似 App 的使用体验。

安装后务必确认：模块/插件已下载成功、开关已开启，并信任 MitM 证书。若刷新不出新版前端，见 清除前端 PWA 缓存。

Android 版 ​

Docker 自建 ​

官方镜像：xream/sub-store

快速启动示例：

bash
docker run -it -d --restart=always \
 -e "SUB_STORE_FRONTEND_BACKEND_PATH=/2cXaAxRGfddmGz2yx1wA" \
 -e "SUB_STORE_CORS_ALLOWED_ORIGINS=https://sub-store-frontend.a.com" \
 -p 127.0.0.1:3001:3001 \
 -v /root/sub-store-data:/opt/app/data \
 --name sub-store \
 xream/sub-store
  • 前端默认监听 3001 端口，后端 API 默认 3000 端口。监听地址默认为全部接口（::）：Docker 中只发布需要暴露的前端端口（如上文 -p 127.0.0.1:3001:3001），不要暴露后端 3000 端口，见 环境变量 - 端口与监听
  • 开启 SUB_STORE_BACKEND_MERGE=true 可合并前后端端口，仅暴露一个端口
  • 数据目录挂载到 /opt/app/data，升级容器不会丢数据
  • 如需使用测活等脚本，可选用带 http-meta tag 的镜像
  • 更新：与其他容器一样，可用 Watchtower 自动更新

启动后访问 http://127.0.0.1:3001，后端地址形如 http://127.0.0.1:3001/2cXaAxRGfddmGz2yx1wA（具体前缀由 SUB_STORE_FRONTEND_BACKEND_PATH 决定）。

健康检查

http://127.0.0.1:3001/<后端前缀>/api/utils/env 会返回后端版本信息，可用于健康检查与排查。

常见环境变量见 环境变量

所有环境变量的完整说明见 Docker Hub 页面

使用官方前端 ​

不需要安装任何东西，直接在浏览器打开 https://sub-store.vercel.app 即可使用（一般需要能正常访问 Vercel）。

自建后端时，在前端「我的」页设置后端地址即可连接。

前端为 PWA，未刷新出最新版时请参考 清除前端 PWA 缓存。

更多参考 ​