sub-converter

项目简介

sub-converter 是一个支持多种客户端格式的订阅链接转换与短链生成服务，支持 Singbox、Clash、Surge、Xray 等主流代理配置格式。支持多语言界面、在线转换、短链跳转、订阅配置存储等功能，适合自部署和团队共享。

温馨提示

• main主分支为cloudflare worker部署使用，server分支为服务器/docker容器等构建所需的源代码
• 如需部署公共服务使用，请使用docker部署或vps部署，cloudflare worker的KV有请求限制

主要功能

• 订阅链接格式互转（Singbox/Clash/Surge/Xray）
• 在线生成和管理短链，支持跳转
• 支持多语言切换（中/英/俄/波斯）
• 支持自定义规则、UA、基础配置
• 支持订阅配置存储与解析
• 支持 Docker部署或vps源代码部署

server分支目录结构简述

├── src/                # 核心业务代码
│   ├── kvSqlite.js     # SQLite 持久化 KV 封装
│   ├── ...             # 其它 builder、工具、i18n
├── database/           # SQLite 数据库存储目录（持久化）
├── server.js           # Node.js 启动入口
├── package.json        # 依赖与脚本
├── Dockerfile          # Docker 构建文件

• API 文档（APIDoc.md）

源码构建与运行

1. 安装依赖

   npm install

2. 启动服务（默认 7788 端口）

   npm start
   # 或指定端口
   PORT=8080 npm start

3. 访问
   • http://localhost:7788

Docker 构建与运行

1. 直接拉取并运行镜像

   docker run -d \
     -v $(pwd)/database:/app/database \
     -p 7788:7788 \
     --name sub-converter \
     eooce/sub-converter:latest

   持久化目录 $(pwd)/database 用于保存 SQLite 数据库文件, 默认当前目录

Docker Compose 部署示例

新建 docker-compose.yml：

version: '3'
services:
  sub-converter:
    image: ghcr.io/eooce/sub-converter:latest
    container_name: sub-converter
    ports:
      - "7788:7788"
    volumes:
      - ./database:/app/database
    restart: unless-stopped

启动：

docker-compose up -d

数据持久化说明

• 所有短链、配置等数据均存储于 database/sublink_kv.db（SQLite）
• 挂载 database 目录可实现数据持久化，适合 Docker 部署
• 首次运行自动创建 database 目录，无需手动操作

主要依赖

• Node.js >=14 <=20
• express
• better-sqlite3
• js-yaml

环境变量说明

• PORT：服务监听端口，默认 7788。可通过 PORT=8080 npm start 或 docker-compose 的 environment 配置自定义。

Cloudflare Workers 网页端一键部署

1. Fork 本项目main分支到你的 GitHub 账号。
2. 打开 Cloudflare Workers 控制台。
3. 选择 "Connect to Git" → 选择你的 GitHub 账号和 Fork 后的仓库。
4. 选择 server 分支（或你需要的分支）。
5. 保持默认构建设置（Node.js 项目会自动识别）。
6. 在 "Environment Variables" 或 "KV Namespaces" 里添加/绑定所需的 KV 命名空间（如 SUBLINK_KV）。
7. 点击 "Deploy" 即可一键部署，无需本地命令行操作。

注意事项：

• 首次部署需授权 Cloudflare 访问你的 GitHub 仓库。
• KV 命名空间需在 Cloudflare 控制台提前创建并绑定到 Worker。
• 如需自定义域名，可在 Cloudflare 控制台绑定。

---

如有问题或建议，欢迎 issue 或 PR！

原项目readme（点击展开）

Sublink Worker

One Worker, All Subscriptions

A lightweight subscription converter and manager for proxy protocols, deployable on Cloudflare Workers, Vercel, Node.js, or Docker.

📚 Documentation

⚡️ Live Demo · Documentation 中文文档·

Quick Start · API Reference · FAQ

🚀 Quick Start

One-Click Deployment

• Choose a "deploy" button above to click
• That's it! See the Document for more information.

Alternative Runtimes

• Node.js: npm run build:node && node dist/node-server.cjs
• Vercel: vercel deploy (configure KV in project settings)
• Docker: docker pull ghcr.io/7sageer/sublink-worker:latest
• Docker Compose: docker compose up -d (includes Redis)

✨ Features

Supported Protocols

ShadowSocks • VMess • VLESS • Hysteria2 • Trojan • TUIC

Client Support

Sing-Box • Clash • Xray/V2Ray • Surge

Input Support

• Base64 subscriptions
• HTTP/HTTPS subscriptions
• Full configs (Sing-Box JSON, Clash YAML, Surge INI)

Core Capabilities

• Import subscriptions from multiple sources
• Generate fixed/random short links (KV-based)
• Light/Dark theme toggle
• Flexible API for script automation
• Multi-language support (Chinese, English, Persian, Russian)
• Web interface with predefined rule sets and customizable policy groups

🤝 Contributing

Issues and Pull Requests are welcome to improve this project.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Disclaimer

This project is for learning and exchange purposes only. Please do not use it for illegal purposes. All consequences resulting from the use of this project are solely the responsibility of the user and are not related to the developer.

💰 Sponsorship

Thanks to the following sponsors for their support of this project

If you would like to sponsor this project, please contact the developer @7Sageer

⭐️ Star History

Thanks to everyone who has starred this project! 🌟