NeTube

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

Supported Protocols

Backend subscriptions can import Shadowsocks, VMess, VLESS (including TLS and Reality), Trojan, Hysteria2, HTTP/HTTPS proxy, and ordinary SOCKS5 nodes from the formats supported by each backend parser. HTTP nodes may use TLS.

Backend sources use one of three explicit formats: clash for YAML, shadowrocket for a whole-body Base64-encoded URI list, or uri-list for UTF-8 plain text with one URI per non-empty line. Plain URI lists may contain blank lines and lines beginning with #; the configured type, not the HTTP response header, selects the parser.

Public endpoint configuration supports mixed and Shadowsocks. A mixed endpoint accepts HTTP CONNECT and SOCKS4/4a/5 on one port. When TLS is enabled, it terminates TLS before protocol detection, so both HTTPS proxy clients and clients that support TLS-wrapped SOCKS5 can connect to that endpoint.

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