快速开始

Sublink Worker 的核心目标是尽可能降低订阅转换 / 分发工具的自托管门槛。下面根据最常见的部署方式整理了三步上手流程。

1. Cloudflare Workers 一键部署

如果你之前通过Cloudflare部署过Github应用，可能会出现An unknown error occurd错误，可参考FAQ。

点击上方按钮即可自动完成 Fork 和部署。或者手动操作：

1. 进入 Cloudflare Dashboard，选择 Workers & Pages → Create application → Pages → Connect to Git。
2. 授权 GitHub 并选择 Fork 后的 sublink-worker 仓库。
3. 在 Build 设置中：
   • Framework preset：None。
   • Build command：npm run deploy。
   • Build output directory：保持默认。
4. 绑定自定义域名（可选），避免 *.workers.dev 在国内不可访问的问题。

部署完成后，Cloudflare 会注入 KV 以及 Worker 环境变量，默认即可运行；若需绑定 Redis/Upstash，请继续阅读运行与存储。

2. Vercel 部署

点击上方按钮即可快速部署到 Vercel，系统会自动引导你配置必要的环境变量。或者手动操作：

1. 在 Vercel 控制台导入 Fork 仓库。
2. 前往 Settings → Environment Variables 写入 KV_REST_API_URL 和 KV_REST_API_TOKEN（若使用 Vercel KV 会自动生成）。
3. 执行 vercel deploy，即可得到 /api/index.js 驱动的无服务器应用。

3. Docker / Compose 部署

Docker Compose (推荐)

# 克隆仓库
git clone https://github.com/7Sageer/sublink-worker.git
# 进入目录
cd sublink-worker
# 启动
docker compose up -d

Docker Run

docker run -p 8787:8787 ghcr.io/7sageer/sublink-worker:latest

默认情况下直接运行Docker容器不会持久化数据，短链/配置等数据会丢失。推荐配置 Redis/Upstash 以持久化数据，详见 运行与存储。

4. Node.js 部署

# 克隆仓库
git clone https://github.com/7Sageer/sublink-worker.git
# 进入目录
cd sublink-worker
# 安装依赖
npm install
# 构建
npm run build:node
# 运行
node dist/node-server.cjs

默认情况下直接运行Node.js不会持久化数据，短链/配置等数据会丢失。推荐配置 Redis/Upstash 以持久化数据，详见 运行与存储。

对于 Node.js，推荐使用 PM2 等进程管理工具。

生成你的第一份订阅

1. 打开 Worker 根路径（或 Docker 暴露的 http://localhost:8787）。
2. 粘贴已经 Base64/URL 编码的订阅。
3. 选择规则模板（Balanced/Comprehensive 等），或在下方追加自定义规则。
4. 点击 Convert，即可导出 Sing-Box、Clash、Surge、Xray 配置或二维码；若勾选短链会将链接存入 KV。

更进一步的存储/变量说明见 运行与存储；若你计划改写基础配置，请直接跳到 基础配置（实验）。