sing-box

This repository contains a one-command install and management script for sing-box, an open-source proxy platform that supports multiple tunneling protocols. The script is written in Shell and runs on Linux servers. The README is written in Chinese.

Sing-box itself is a proxy tool that can run several different protocols: VLESS-REALITY, TUIC, Trojan, Hysteria2, AnyTLS, Shadowsocks 2022, and several VMess variants using different transports like WebSocket, HTTP/2, and QUIC. Each protocol has different characteristics in terms of speed, obfuscation, and how it handles network restrictions.

This management script wraps sing-box so you can add, change, view, and delete proxy configurations through short commands without editing configuration files by hand. Adding a new configuration takes a single command and completes almost instantly. The script handles TLS certificate setup automatically, meaning HTTPS encryption is configured for you without manual certificate management. It also includes a one-command option to enable BBR, a Linux kernel congestion control algorithm that can improve throughput on some networks.

The design goal described in the README is to run multiple configurations at the same time with minimal effort. You can change individual parameters of a running configuration, such as port, UUID, password, domain, encryption method, or the camouflage website that hides the proxy traffic, all through single commands. Existing v2ray or sing-box configuration files can also be imported.

The script includes commands for checking service status, viewing logs, testing a configuration before going live, and updating sing-box or the script itself. Full documentation is hosted at the author's website at 233boy.com.