Go to file
ffdfgdfg 5390e965a9
Merge pull request #327 from cnlh/master
master
2019-12-24 13:07:11 +08:00
.github/ISSUE_TEMPLATE Update issue templates 2019-11-28 21:21:16 +08:00
bridge fix udp nil && add version display on web 2019-12-04 01:28:26 +08:00
client fix client status when close client 2019-12-08 21:15:27 +08:00
cmd print log when run with nps 2019-12-19 00:46:22 +08:00
conf add web https 2019-12-14 17:39:46 +08:00
docs Merge pull request #327 from cnlh/master 2019-12-24 13:07:11 +08:00
gui/npc add manifest 2019-12-22 22:55:27 +08:00
image Donation image 2019-03-27 15:18:04 +08:00
lib remove mux connection deadline 2019-12-19 22:24:58 +08:00
server add web https 2019-12-14 17:39:46 +08:00
web fix button not working on firefox 2019-12-21 15:35:55 +08:00
.gitattributes Update .gitattributes 2018-12-11 16:54:21 +08:00
.gitignore feat: go mod supported 2019-08-10 11:10:01 +08:00
.travis.yml change build.sh 2019-12-17 00:47:07 +08:00
Dockerfile.npc minor bug fix, docker 2019-11-27 22:46:34 +08:00
Dockerfile.nps minor bug fix, docker 2019-11-27 22:46:34 +08:00
LICENSE License 2019-03-27 11:23:16 +08:00
Makefile feat: go mod supported 2019-08-10 11:10:01 +08:00
README.md Update README.md 2019-12-21 11:49:35 +08:00
build.android.sh add manifest 2019-12-22 22:55:27 +08:00
build.sh build android script 2019-12-17 15:31:25 +08:00
go.mod add npc install and update 2019-12-16 17:15:05 +08:00
go.sum add npc install and update 2019-12-16 17:15:05 +08:00

README.md

nps

Gitter Build Status GitHub All Releases

nps是一款轻量级、高性能、功能强大的内网穿透代理服务器。目前支持tcp、udp流量转发,可支持任何tcp、udp上层协议访问内网网站、本地支付接口调试、ssh访问、远程桌面内网dns解析等等……此外还支持内网http代理、内网socks5代理p2p等并带有功能强大的web管理端。

背景

image

  1. 做微信公众号开发、小程序开发等----> 域名代理模式

  2. 想在外网通过ssh连接内网的机器做云服务器到内网服务器端口的映射----> tcp代理模式

  3. 在非内网环境下使用内网dns或者需要通过udp访问内网机器等----> udp代理模式

  4. 在外网使用HTTP代理访问内网站点----> http代理模式

  5. 搭建一个内网穿透ss在外网如同使用内网vpn一样访问内网资源或者设备----> socks5代理模式

特点

  • 协议支持全面兼容几乎所有常用协议例如tcp、udp、http(s)、socks5、p2p、http代理...
  • 全平台兼容(linux、windows、macos、群辉等),支持一键安装为系统服务
  • 控制全面,同时支持服务端和客户端控制
  • https集成支持将后端代理和web服务转成https同时支持多证书
  • 操作简单只需简单的配置即可在web ui上完成其余操作
  • 展示信息全面,流量、系统信息、即时带宽、客户端版本等
  • 扩展功能强大,该有的都有了(缓存、压缩、加密、流量限制、带宽限制、端口复用等等)
  • 域名解析具备自定义header、404页面配置、host修改、站点保护、URL路由、泛解析等功能
  • 服务端支持多用户和用户注册功能

没找到你想要的功能?不要紧,点击进入文档查找吧

快速开始

安装

releases

下载对应的系统版本即可,服务端和客户端是单独的

服务端启动

下载完服务器压缩包后,解压,然后进入解压后的文件夹

  • 执行安装命令

对于linux|darwin sudo ./nps install

对于windows管理员身份运行cmd进入安装目录 nps.exe install

  • 启动

对于linux|darwin sudo nps start

对于windows管理员身份运行cmd进入程序目录 nps.exe start

安装后windows配置文件位于 C:\Program Files\npslinux和darwin位于/etc/nps

如果发现没有启动成功,可以查看日志(Windows日志文件位于当前运行目录下linux和darwin位于/var/log/nps.log)

  • 访问服务端ip:web服务端口默认为8080
  • 使用用户名和密码登陆默认admin/123正式使用一定要更改
  • 创建客户端

客户端连接

  • 点击web管理中客户端前的+号,复制启动命令
  • 执行启动命令linux直接执行即可windows将./npc换成npc.exe用cmd执行

如果需要注册到系统服务可查看注册到系统服务

配置

  • 客户端连接后在web中配置对应穿透服务即可
  • 更多高级用法见完整文档

贡献

  • 如果遇到bug可以直接提交至dev分支
  • 使用遇到问题可以通过issues反馈
  • 项目处于开发阶段,还有很多待完善的地方,如果可以贡献代码,请提交 PR 至 dev 分支
  • 如果有新的功能特性反馈可以通过issues或者qq群反馈