nps README

The project's README from github.com/ehang-io/nps. As one markdown file: README.md.

NPS

Gitter Release GitHub All Releases

README|中文文档

NPS is a lightweight, high-performance, powerful intranet penetration proxy server, with a powerful web management terminal.

image

Feature

Didn't find the feature you want? It doesn't matter, click Enter the document to find it!

Quick start

Installation

releases

Download the corresponding system version, the server and client are separate.

Server start

After downloading the server compressed package, unzip it, and then enter the unzipped folder.

For linux、darwin sudo ./nps install

For windows, run cmd as administrator and enter the installation directory nps.exe install

The default configuration file of nps use 80,443,8080,8024 ports

80 and 443 ports for host mode default ports

8080 for web management access port

8024 for net bridge port, to communicate between server and client

For linux、darwin sudo nps start

For windows, run cmd as administrator and enter the program directory nps.exe start

After installation, the windows configuration file is located at C:\Program Files\nps, linux or darwin is located at /etc/nps

If you don't find it started successfully, you can check the log (Windows log files are located in the current running directory, linux and darwin are located in /var/log/nps.log).

Client connection

If you need to register to the system service, you can check Register to the system service

Configuration

Contribution

nps (ehang-io/nps)

udp
Searching Database…

34.2K ·GitHub
What is this?NPS is a lightweight, high-performance intranet penetration (reverse proxy/tunnel) server that exposes internal network services to the outside world. It forwards tcp, udp, http(s), socks5 and other protocols, and comes with a full-featured web admin panel.
Is this a single binary or do I need separate server and client pieces?It ships as two separate binaries: a server (nps) you run on a machine with a public IP, and a client (npc) you run inside the private network you want to expose.
How do I get the tunnel running?Download the matching release, unzip it, run the install command for your OS, then start the server. Log into the web UI on the configured port, create a client, copy its generated startup command and run it on the machine behind the NAT/firewall.
Do I need any extra software installed first?No, it's a single compiled Go binary for server and client with no extra runtime required; on Windows you just need to run cmd as administrator to install/start it.
What ports does it use by default, and is there anything I must change before going live?By default it uses ports 80/443 for host mode, 8080 for the web admin panel, and 8024 as the bridge port between server and client; the default admin login (admin/123) must be changed before real use.
Who would use this, e.g. for SSH or remote desktop access into a private network?Anyone needing to reach internal resources from outside: accessing an intranet website, debugging local payment callback APIs, SSH, remote desktop, internal DNS resolution, or exposing an internal socks5 proxy.
Does it run on more than just Linux?Yes, both server and client support full cross-platform compatibility including Linux, Windows, macOS, and even Synology NAS, and can be installed as a system service.
Does NPS support encryption or compression for the tunneled traffic?Yes, it has powerful extension functions including traffic encryption, gzip compression, bandwidth and traffic limiting, and port reuse.
Can it convert a plain backend service into HTTPS?Yes, NPS can integrate HTTPS for proxied backends and supports configuring multiple SSL certificates.
Does it support multiple users?Yes, the server supports multi-user management and user self-registration.
How do domain-based routing features work?The web panel lets you configure custom headers, 404 pages, host rewriting, site protection, URL routing, and wildcard (pan-resolution) domain binding for forwarded sites.
What are similar projects?goproxy, chisel, gost, rathole, ProxyBridge, frp, proxychains-ng, tailcat
Which topics is it in?nat, socks, udp, tcp, https, firewall, socks5, gpl, tunnel, dns, reverse-proxy, ssh
Creator
ehang-io
Size
9 MB
Stars
34.2K
Age
7y
Commits · 90 Days