## π Quick Start
### One-Click Deployment
- Choose a "deploy" button above to click
- That's it! See the [Document](https://sublink.works/guide/quick-start/) 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](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! π
