Deploy nps: Open‑Source All‑Protocol Network Tunnel Made Simple

Overview

The open‑source project nps provides a protocol‑agnostic tunneling solution that enables access to internal services from outside networks. It supports HTTP, TCP, UDP, and SOCKS5 proxy traffic, offers built‑in TLS encryption, and includes a web‑based management console for configuring tunnels, monitoring connections, and managing users.

Key Technical Features

All‑Protocol Compatibility : Forward HTTP, TCP (e.g., databases), UDP (e.g., game traffic), and SOCKS5 proxy through a single tunnel.

Visual Management UI : Web dashboard replaces manual command‑line configuration; policies are set with mouse clicks.

Enterprise‑Grade Performance : Multiplexing and intelligent traffic scheduling keep throughput stable under many concurrent connections.

Cross‑Platform Support : Native binaries run on Linux, Windows, macOS, Raspberry Pi, and NAS devices.

Encrypted Transfer : TLS channels protect data in transit; access control limits who can create tunnels.

Low Resource Usage : Optimized memory and CPU consumption allow long‑term operation on constrained hardware.

Bandwidth Management : Per‑tunnel bandwidth limits and priority settings prevent a single service from monopolizing the link.

Real‑Time Monitoring : Dashboard charts show connection status, traffic volume, and system health.

Multi‑Tenant Permissions : Create independent user accounts and groups for team collaboration.

Quick Deployment Workflow

Three main steps are required: download the binaries, install the service, and start it. A public‑IP server (cloud or self‑hosted) acts as the relay node.

Server Installation

Upload the server archive to the public server and extract it to a chosen directory.

Register the service: sudo ./nps install on Linux or run nps.exe install with administrator rights on Windows.

Start the service: sudo nps start (Linux) or nps.exe start (Windows).

Open a browser and navigate to http://<em>server‑IP</em>:8080 to access the management console.

Log in with the default credentials admin/123 and change the password immediately.

In the UI, add a new client connection; the system generates a unique connection key.

Client Setup

Copy the generated client connection command from the management console.

Download the matching client binary on the internal device and extract it.

Execute the command in a terminal; on Windows replace ./npc with npc.exe.

After the client connects, return to the web UI to define tunnel rules and port mappings (e.g., HTTP proxy, TCP forward, UDP forward, or SOCKS5).

Typical Application Scenarios

Personal Cloud Storage : Expose a home NAS via HTTP tunneling to create a private cloud drive accessible from anywhere.

Live Development Demo : Map a domain to a local development server so clients can preview changes in real time.

Remote Operations : Use SSH tunneling to maintain internal servers without VPN configuration.

Private Game Servers : Forward TCP/UDP traffic to host games such as Minecraft for friends.

Each scenario is configured by selecting the appropriate proxy type in the dashboard, entering the source address and destination port, and saving the rule—no deep protocol knowledge required.

Project Repository

GitHub repository: https://github.com/ehang-io/nps