NPS 内网穿透安装配置文档
1.About
一款轻量级、高性能、功能强大的内网穿透代理服务器。支持tcp、udp、socks5、http等几乎所有流量转发,可用来访问内网网站、本地支付接口调试、ssh访问、远程桌面,内网dns解析、内网socks5代理等等……,并带有功能强大的web管理端。
2. GitHub地址及相关文档
github地址: https://github.com/ehang-io/nps
说明文档: https://ehang-io.github.io/nps/#/description
3. 简单介绍
① 本次记录的是使用内网穿透的供能
②原因: 因微信支付需要做回调,所以本地测试需要做内网穿透
③使用nps做内网穿透的几点要求:
要求1: 必须有一个公网的服务器,含有静态ip
要求2:熟悉linux 基础操作
要求3: 本次服务器端使用的centos7.5 x86架构系统,客户端为windows系统(官方文档有别的系统配置)
④需要下载一个服务端,一个客户端 。服务端放在公网服务器 上,客户端放在本地局域网的某台机器上或路由器上(本次放 在本机)
4. 服务器端配置nps
mkdir -p /nps/server #创建多级目录
cd /nps/server
#下载到server目录下并解压
wget https://github.com/ehang-io/nps/releases/download/v0.26.9/linux_386_server.tar.gz
tar -zxvf linux_386_server.tar.gz
#解压后会含有一下目录及文件
# conf nps web
下载完服务器压缩包后,解压,然后进入解压后的文件夹
执行安装命令
对于linux|darwin sudo ./nps install
修改配置文件
配置文件在 /etc/nps/conf/nps.conf ,只需要修改下面的web的host、账号、密码和端口号即可,其他可保持不变
appname = nps
#Boot mode(dev|pro)
runmode = dev
#HTTP(S) proxy port, no startup if empty
http_proxy_ip=0.0.0.0
http_proxy_port=80
https_proxy_port=443
https_just_proxy=true
#default https certificate setting
https_default_cert_file=conf/server.pem
https_default_key_file=conf/server.key
##bridge
bridge_type=tcp
#客户端连接端口
bridge_port=8024
bridge_ip=0.0.0.0
# Public password, which clients can use to connect to the server
# After the connection, the server will be able to open relevant ports and parse related domain names according to its own configuration file.
public_vkey=123
#Traffic data persistence interval(minute)
#Ignorance means no persistence
#flow_store_interval=1
# log level LevelEmergency->0 LevelAlert->1 LevelCritical->2 LevelError->3 LevelWarning->4 LevelNotice->5 LevelInformational->6 LevelDebug->7
log_level=7
#log_path=nps.log
#Whether to restrict IP access, true or false or ignore
#ip_limit=true
#p2p
#p2p_ip=127.0.0.1
#p2p_port=6000
#web
#面板host
web_host=39.96.87.0
#面板账号
web_username=nmy
#面板密码
web_password=nmy
#面板启动端口号
web_port = 8888
web_ip=0.0.0.0
web_base_url=
#是否开启https默认不开启
web_open_ssl=false
web_cert_file=conf/server.pem
web_key_file=conf/server.key
# if web under proxy use sub path. like http://host/nps need this.
#web_base_url=/nps
#Web API unauthenticated IP address(the len of auth_crypt_key must be 16)
#Remove comments if needed
#auth_key=test
auth_crypt_key =1234567812345678
#allow_ports=9001-9009,10001,11000-12000
#Web management multi-user login
allow_user_login=false
allow_user_register=false
allow_user_change_username=false
#extension
allow_flow_limit=false
allow_rate_limit=false
allow_tunnel_num_limit=false
allow_local_proxy=false
allow_connection_num_limit=false
allow_multi_ip=false
system_info_display=false
#cache
http_cache=false
http_cache_length=100
#get origin ip
http_add_origin_header=false
#pprof debug options
#pprof_ip=0.0.0.0
#pprof_port=9999
#client disconnect timeout
disconnect_timeout=60
启动nps 对于linux|darwin sudo nps start
如果发现没有启动成功,可以使用nps(.exe) stop
,然后运行nps.(exe)
运行调试,或查看日志(Windows日志文件位于当前运行目录下,linux和darwin位于/var/log/nps.log)
-
访问服务端ip:web服务端口(默认为8080)
-
使用用户名和密码登陆(默认admin/123,正式使用一定要更改)
-
创建客户端
5.客户端简单配置
windows下载客户端地址 :https://github.com/ehang-io/nps/releases/download/v0.26.9/windows_amd64_client.tar.gz
下载完成之后解压:
获得conf ,npc.exe 文件,然后登录你的nps 面板,新建一个客户端
配置客户端
-
下载客户端安装包并解压,进入到解压目录
-
点击web管理中客户端前的+号,复制启动命令
-
执行启动命令,linux直接执行即可,windows将./npc换成npc.exe用cmd执行
建议直接以客户端命令执行(将命令放入cmd 中即可)
没有问题的话,到这里就可以结束了
以下是客户端的基本配置
6.客户端复杂使用
此模式的各种配置在服务端web管理中完成,客户端除运行一条命令外无需任何其他设置
./npc -server=ip:port -vkey=web界面中显示的密钥Copy to clipboardErrorCopied
对于linux、darwin
-
注册:
sudo ./npc install 其他参数(例如-server=xx -vkey=xx或者-config=xxx)
-
启动:
sudo npc start
-
停止:
sudo npc stop
-
如果需要更换命令内容需要先卸载
./npc uninstall
,再重新注册
对于windows,使用管理员身份运行cmd
-
注册:
npc.exe install 其他参数(例如-server=xx -vkey=xx或者-config=xxx)
-
启动:
npc.exe start
-
停止:
npc.exe stop
-
如果需要更换命令内容需要先卸载
npc.exe uninstall
,再重新注册 -
如果需要当客户端退出时自动重启客户端,请按照如图所示配置
注册到服务后,日志文件windows位于当前目录下,linux和darwin位于/var/log/npc.log
首先进入到对于的客户端二进制文件目录
请首先执行sudo npc stop
或者npc.exe stop
停止运行,然后
对于linux
sudo npc-update updateCopy to clipboardErrorCopied
对于windows
npc-update.exe updateCopy to clipboardErrorCopied
更新完成后,执行执行sudo npc start
或者npc.exe start
重新运行即可完成升级
如果无法更新成功,可以直接自行下载releases压缩包然后覆盖原有的npc二进制文件
此模式使用nps的公钥或者客户端私钥验证,各种配置在客户端完成,同时服务端web也可以进行管理
./npc -config=npc配置文件路径Copy to clipboardErrorCopied
[common]
server_addr=1.1.1.1:8024
conn_type=tcp
vkey=123
username=111
password=222
compress=true
crypt=true
rate_limit=10000
flow_limit=100
remark=test
max_conn=10
#pprof_addr=0.0.0.0:9999Copy to clipboardErrorCopied
项 | 含义 |
---|---|
server_addr | 服务端ip/域名:port |
conn_type | 与服务端通信模式(tcp或kcp) |
vkey | 服务端配置文件中的密钥(非web) |
username | socks5或http(s)密码保护用户名(可忽略) |
password | socks5或http(s)密码保护密码(可忽略) |
compress | 是否压缩传输(true或false或忽略) |
crypt | 是否加密传输(true或false或忽略) |
rate_limit | 速度限制,可忽略 |
flow_limit | 流量限制,可忽略 |
remark | 客户端备注,可忽略 |
max_conn | 最大连接数,可忽略 |
pprof_addr | debug pprof ip:port |
[common]
server_addr=1.1.1.1:8024
vkey=123
[web1]
host=a.proxy.com
target_addr=127.0.0.1:8080,127.0.0.1:8082
host_change=www.proxy.com
header_set_proxy=npsCopy to clipboardErrorCopied
项 | 含义 |
---|---|
web1 | 备注 |
host | 域名(http |
target_addr | 内网目标,负载均衡时多个目标,逗号隔开 |
host_change | 请求host修改 |
header_xxx | 请求header修改或添加,header_proxy表示添加header proxy:nps |
[common]
server_addr=1.1.1.1:8024
vkey=123
[tcp]
mode=tcp
target_addr=127.0.0.1:8080
server_port=9001Copy to clipboardErrorCopied
项 | 含义 |
---|---|
mode | tcp |
server_port | 在服务端的代理端口 |
tartget_addr | 内网目标 |
[common]
server_addr=1.1.1.1:8024
vkey=123
[udp]
mode=udp
target_addr=127.0.0.1:8080
server_port=9002Copy to clipboardErrorCopied
项 | 含义 |
---|---|
mode | udp |
server_port | 在服务端的代理端口 |
target_addr | 内网目标 |
[common]
server_addr=1.1.1.1:8024
vkey=123
[http]
mode=httpProxy
server_port=9003Copy to clipboardErrorCopied
项 | 含义 |
---|---|
mode | httpProxy |
server_port | 在服务端的代理端口 |
[common]
server_addr=1.1.1.1:8024
vkey=123
[socks5]
mode=socks5
server_port=9004
multi_account=multi_account.confCopy to clipboardErrorCopied
项 | 含义 |
---|---|
mode | socks5 |
server_port | 在服务端的代理端口 |
multi_account | socks5多账号配置文件(可选),配置后使用basic_username和basic_password无法通过认证 |
[common]
server_addr=1.1.1.1:8024
vkey=123
[secret_ssh]
mode=secret
password=ssh2
target_addr=10.1.50.2:22Copy to clipboardErrorCopied
项 | 含义 |
---|---|
mode | secret |
password | 唯一密钥 |
target_addr | 内网目标 |
[common]
server_addr=1.1.1.1:8024
vkey=123
[p2p_ssh]
mode=p2p
password=ssh2
target_addr=10.1.50.2:22Copy to clipboardErrorCopied
项 | 含义 |
---|---|
mode | p2p |
password | 唯一密钥 |
target_addr | 内网目标 |
利用nps提供一个公网可访问的本地文件服务,此模式仅客户端使用配置文件模式方可启动
[common]
server_addr=1.1.1.1:8024
vkey=123
[file]
mode=file
server_port=9100
local_path=/tmp/
strip_pre=/web/Copy to clipboardErrorCopied
项 | 含义 |
---|---|
mode | file |
server_port | 服务端开启的端口 |
local_path | 本地文件目录 |
strip_pre | 前缀 |
对于strip_pre
,访问公网ip:9100/web/
相当于访问/tmp/
目录
[common]
auto_reconnection=true