sublink-worker Documentation

GitHub

One Worker, All Subscriptions

5,492 stars

JavaScript 1 file · ~1,013 tokens #clash #clash-meta #cloudflare-workers #mihomo #singbox #v2rayn #v2rayng #xray-core

RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy sublink-worker on any server, homelab, or cloud container platform.

Raw YAML Docker Page → JSON API

1-Click Terminal Command

bash (docker run)

docker run -d --name sublink-worker -p 8787:8787 --restart always redis:7-alpine

Configured Services & Ports

⚙️ worker

image: ${SUBLINK_WORKER_IMAGE:-ghcr.io/7sageer/sublink-worker:latest}

🔌 Ports: 8787:8787

⚙️ redis

image: redis:7-alpine

docker-compose.yml

yaml (docker-compose.yml)

services:
  worker:
    image: ${SUBLINK_WORKER_IMAGE:-ghcr.io/7sageer/sublink-worker:latest}
    pull_policy: always
    ports:
      - "8787:8787"
    environment:
      REDIS_HOST: redis
      REDIS_PORT: 6379
      REDIS_KEY_PREFIX: sublink
      # Set to 0 to keep stored configs without automatic expiration.
      CONFIG_TTL_SECONDS: 2592000
    depends_on:
      - redis
  redis:
    image: redis:7-alpine
    command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
    volumes:
      - redis-data:/data
      - ./redis.conf:/usr/local/etc/redis/redis.conf:ro
    restart: unless-stopped
volumes:
  redis-data:

Technical Documentation: 7Sageer/sublink-worker

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`)

🚀 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.

⭐ Star History

Thanks to everyone who has starred this project! 🌟

--- METRICS ---

Files Extracted: 1
Estimated Token Budget: ~930 tokens
Canonical Reference: https://codewiki.google/github.com/7Sageer/sublink-worker

Docker & Self-Hosted Deployment Verified OCI

Technical Documentation: 7Sageer/sublink-worker

Overview (`README.md`) Copy Section

🚀 Quick Start Copy Chapter

One-Click Deployment Copy Section

Alternative Runtimes Copy Section

✨ Features Copy Chapter

Supported Protocols Copy Section

Client Support Copy Section

Input Support Copy Section

Core Capabilities Copy Section

🤝 Contributing Copy Chapter

📄 License Copy Chapter

⚠️ Disclaimer Copy Chapter

⭐ Star History Copy Chapter

Explore Related Technologies & Topics