nps/README.md

2.9 KiB
Raw Blame History

nps

Gitter Build Status

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代理模式

快速开始

安装

releases

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

服务端启动

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

  • 执行安装命令

对于linux|darwin sudo ./nps install

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

  • 启动

对于linux|darwin sudo nps start

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

停止和重启可用stop和restart

如果发现没有启动成功,可以查看日志(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群反馈