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)

Searching Database…

34.2K ·GitHub
这是什么?NPS 是一款轻量、高性能的内网穿透(反向代理/隧道)服务端,可以把内网服务暴露到外网。它支持 tcp、udp、http(s)、socks5 等协议的转发,并附带功能完整的 Web 管理面板。
这是单个二进制文件,还是我需要分别部署服务端和客户端?它提供两个独立的二进制文件:服务端 nps 运行在有公网 IP 的机器上,客户端 npc 运行在你想要暴露的内网中。
我该如何让隧道跑起来?下载对应的发行版并解压,为你的系统运行安装命令,然后启动服务端。通过配置的端口登录 Web 界面,创建一个客户端,复制其生成的启动命令,并在位于 NAT/防火墙后面的机器上运行。
我需要先安装额外的软件吗?不需要。服务端和客户端都是单个编译好的 Go 二进制文件,无需额外的运行环境;在 Windows 上只需以管理员身份运行 cmd 即可完成安装和启动。
默认使用哪些端口?上线前有什么必须修改的吗?默认情况下,host 模式使用 80/443 端口,Web 管理面板使用 8080 端口,服务端与客户端之间的桥接端口为 8024;默认管理员账号 admin/123 必须在正式使用前修改。
谁会用到这个?例如通过 SSH 或远程桌面访问内网?任何需要从外部访问内网资源的人:访问内网网站、调试本地支付回调接口、SSH、远程桌面、内网 DNS 解析,或暴露内网的 socks5 代理。
它是否不仅能在 Linux 上运行?可以。服务端和客户端都完整支持跨平台,包括 Linux、Windows、macOS,甚至群晖 NAS,并且可以安装为系统服务。
NPS 是否支持对隧道流量进行加密或压缩?支持。它提供强大的扩展功能,包括流量加密、gzip 压缩、带宽与流量限制以及端口复用。
能否把普通的后端服务转换为 HTTPS?可以。NPS 能为转发的后端集成 HTTPS,并支持配置多个 SSL 证书。
是否支持多用户?支持。服务端支持多用户管理和用户自助注册。
基于域名的路由功能如何工作?Web 面板可以为转发的站点配置自定义请求头、404 页面、host 重写、站点保护、URL 路由,以及泛解析域名绑定。
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