NeTube

A proxy aggregation service that fetches nodes from subscriptions, automatically selects the best node according to configurable policies, and exposes unified SOCKS5 and Shadowsocks ports. A web management dashboard is included.

Supported Protocols

Backend subscriptions can import Shadowsocks, VMess, VLESS (including TLS and Reality), Trojan, and Hysteria2 nodes from the formats supported by each backend parser. Public endpoints remain SOCKS5, mixed, and Shadowsocks; backend VLESS support does not expose a VLESS inbound.

Installation

• Node.js >= 20

npm install -g netube
netube

On its first run, NeTube creates ~/.netube/config.yaml. When singbox.bin is not configured, NeTube checks ~/.netube/sing-box first and then looks for sing-box in the system PATH. If neither is available, the startup message directs you to download the latest stable version from GitHub Releases. Generated sing-box configurations are stored in ~/.netube/singbox/. The default configuration provides a direct mixed proxy listening on 127.0.0.1:1080.

To use a custom configuration:

netube --config /path/to/config.yaml
# Also supported:
netube /path/to/config.yaml

See the example configuration for all available options.

Development

npm install
cd web && npm install && cd ..
npm run dev -- /path/to/config.yaml  # Backend with hot reload
cd web && npm run dev                 # Frontend in another terminal; proxies /api

Testing

npm test

Documentation

• Architecture — system structure, process model, data flow, and module responsibilities
• API reference — complete REST API reference
• Example configuration — all configuration options with explanations