✨ Powerful proxy subscription management and conversion ✨
English | 简体中文
SublinkPro is a deeply refactored and enhanced project based on the excellent open source projects sublinkX and sublinkE. Thanks to the original authors for their work and contributions.
- 🎨 Frontend framework: Based on Berry Free React Material UI Admin Template
- ⚡ Backend stack: Go + Gin + Gorm
- 🔐 Default account:
admin/123456, change it immediately after installation - 💻 Demo: https://demo.sublink.us.kg, username: admin, password: 123456
Warning
| Feature | Description | Details |
|---|---|---|
| 🏷️ Smart tag system | Automatic rule based tagging, no code filtering, IP quality conditions | 📖 |
| ⚡ Professional speed test system | Two stage tests, smart latency measurement, IP quality and unlock checks | 📖 |
| 🔗 Chain proxy | Native Dialer-Proxy support, visual configuration, IP quality based node selection | 📖 |
| 🤖 AI template editing | Generate template drafts from natural language, review with edit and diff views, apply or roll back locally | 📖 |
| Multi format import, scheduled updates, traffic monitoring, one click full refresh | 📖 | |
| 🗂️ Group ordering | Drag airport priority within a group to control node order in subscription output | 📖 |
| 📋 Subscription sharing | Multiple links, expiration policies, access statistics | 📖 |
| 🌐 Host management | Domain mappings, DNS configuration, CDN preferred IPs | 📖 |
| ☁️ Cloudflare Tunnel | Expose the admin UI without a public IP, with cloudflared managed from the page | 📖 |
| 🤖 Telegram Bot | Remote speed tests, subscription management, system monitoring | 📖 |
| 📜 Script system | Node filtering, content post processing, chained scripts | 📖 |
| 🔔 Webhooks | Supports PushDeer, Bark, DingTalk, ServerChan, and other notification platforms | 📖 |
| 🔐 Security features | Token authorization, API Key, IP allow and block lists, access logs | 📖 |
Important
Runtime data is stored in these directories by default. Keep them during upgrades and migrations:
./db: database, configuration files, GeoIP, and other local data./template: template files./logs: runtime logs
Create docker-compose.yml:
services:
sublinkpro:
image: zerodeng/sublink-pro
container_name: sublinkpro
ports:
- "8000:8000"
volumes:
- "./db:/app/db"
- "./template:/app/template"
- "./logs:/app/logs"
restart: unless-stoppedStart the service:
docker-compose up -dOpen http://localhost:8000 and sign in with admin / 123456.
SQLite is used by default. To switch to MySQL or PostgreSQL, set the database connection through SUBLINK_DSN, dsn: in the config file, or the --dsn command line flag. See ⚙️ Configuration for examples.
Note
Even when SUBLINK_WEB_BASE_PATH is configured to hide the admin UI entry, API paths (/api/*) and subscription or share paths (/c/*) stay at the root path. This is a project specific frontend and backend integration rule.
Tip
For more install methods, including Docker, one line scripts, updates, and upgrades, see the 📦 Installation Guide.
Tip
The Docker image includes cloudflared. After signing in, open User Center -> Cloudflare Tunnel, enter the token, and start it. When auto connect is enabled, the Tunnel connects when the service starts.
If your earlier instance used SQLite and you now want to migrate to MySQL or PostgreSQL, use this flow:
- Sign in to the old SQLite instance, open System Backup from the avatar menu in the upper right, and export
backup.zip. - Configure the
DSNfor MySQL or PostgreSQL in the new instance, and make sure the target database is a fresh empty database. - Start the new instance and open
Settings -> Data Migration. - Upload the
backup.zipexported from the old instance. - Choose whether to migrate
AccessKeyand subscription access logs, then start the migration. - After migration completes, manually restart the project instance, then sign in again and check the data.
Important
Using backup.zip is recommended. Uploading a .db file directly migrates database records only and won't restore the template directory.
Note
If you migrate AccessKey, make sure both old and new instances use the same API encryption key; otherwise old API Keys may no longer work.
Tip
If migration finishes with “N warnings”, open the corresponding “Database Migration” task in Task Center to view details.
| Document | Description |
|---|---|
| 📦 Installation | Docker, one line scripts, updates, Watchtower automatic updates |
| ⚙️ Configuration | Environment variables, command line flags, CAPTCHA configuration |
| Document | Description |
|---|---|
| 🏷️ Smart tag system | Automatic rule based tagging, no code filtering, IP quality rules |
| ⚡ Speed test system | Test design, IP quality checks, unlock checks, parameter tuning |
| 🌍 Unlock checks | Streaming and AI availability checks, Provider architecture, extensions |
| 🔗 Chain proxy | Dialer-Proxy, condition based node selection, configuration flow |
| 🤖 AI template editing | AI generated template drafts, edit and diff review, local apply and rollback |
| Subscription import, scheduled updates, traffic monitoring | |
| 📋 Subscription sharing | Multiple links, expiration policies, access statistics |
| 🌐 Host management | Domain mappings, DNS configuration, speed test persistence |
| ☁️ Cloudflare Tunnel | Create a Tunnel, get a token, configure public access |
| 🤖 Telegram Bot | Command list and setup guide |
| 📜 Script support | Node filtering, content post processing, function reference |
| 🔐 Multi factor authentication, MFA | TOTP setup, recovery codes, emergency reset flow |
| Document | Description |
|---|---|
| 🛠️ Development Guide | Project structure, local development, scheduled task development |
| 🔌 Protocol Extension Guide | Add a protocol, register capabilities, field metadata, ProtocolDemo example |
| Client | Supported protocols |
|---|---|
| v2ray | base64 common format, without Clash/mihomo specific protocols such as Mieru |
| clash / mihomo | ss, ssr, trojan, vmess, vless, hy, hy2, tuic, AnyTLS, Socks5, HTTP, HTTPS, Mieru |
| surge | ss, trojan, vmess, hy2, tuic |
Note
Mieru currently supports Clash/mihomo YAML import and export only. Official Mieru has mieru:// and mierus:// share links, but does not define a general URL schema suitable for field by field editing. For raw editing and Clash/mihomo import write back, SublinkPro uses an internal editable form: mieru://username:password@server:port?...#name, with port ranges written as portRange=2090-2099. v2ray and Surge don't support Mieru in SublinkPro. Subscription output skips that protocol instead of converting it to a downgraded form.
Show or hide screenshots
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
If this project helps you, you are welcome to:
- ⭐ Star the project
- 🐛 Open an Issue for bugs or suggestions
- 🔧 Submit a Pull Request
- 📖 Improve the docs and tutorials
If you need to buy a server, you can support the maintainer through the links below. Purchases through these links may provide commission rewards to the maintainer. Check official pages for exact pricing, promotion eligibility, network performance, and renewal rules.
- BandwagonHost: premium routes, multiple data centers, and CN2 GIA options. Good for high quality route servers, or as a stable landing server with other nodes. Highlights: many VPS locations, CN2 GIA optimized routes, quality route machines.
- Vultr: many regions, hourly billing, IP and region changes, starting at $2.5 per month. Good for websites, AI service hosting, route servers, and landing servers. Highlights: many regions, hourly billing, low price, stable service, IPv6 only machines.
- Aliyun: 99 RMB per year server offer with the same price for new purchase and renewal. Good for domestic deployment and testing, including newapi and SublinkPro. Registration through the link may provide discounts, including AI related discounts. Highlights: suitable for China based deployment and development testing, 99 RMB per year new purchase and renewal, discount coupons.
Thanks to these open source projects:
- sublinkX / sublinkE, original projects
- Berry Free React Admin Template, frontend template
- Mihomo, proxy core