基本使用

示范

wget https://github.com/ehang-io/nps/releases/download/v0.26.9/linux_amd64_client.tar.gz

解压

tar -xvzf linux_amd64_client.tar.gz

登录你的nps 面板，新建一个客户端

设置域名解析到服务端IP

进入NPS后台绑定域名以及设置内网IP及端口号

配置域名

启动客户端

第二方案连接设置TCP隧道(建议使用)

填写一个打算用来远程服务的端口号，并将之在路由器上设置端口转发（eg：图中的13389），目标输入pc的IP地址以及端口号。
端口范围：39000-40000

宝塔设置反向代理，不用端口访问网站

无配置文件模式
此模式的各种配置在服务端web管理中完成,客户端除运行一条命令外无需任何其他设置

 ./npc -server=ip:port -vkey=web界面中显示的密钥

注册到系统服务(开机启动、守护进程)
对于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，再重新注册
如果需要当客户端退出时自动重启客户端，请按照如图所示配置

服务端停止或重启

对于linux、darwin

sudo nps stop|restart

对于windows

nps.exe stop|restart

注册到服务后，日志文件windows位于当前目录下，linux和darwin位于/var/log/npc.log

域名这里显示online，就说明绑定成功，已经可以穿透访问了

客户端更新
首先进入到对于的客户端二进制文件目录

请首先执行sudo npc stop或者npc.exe stop停止运行，然后

对于linux

sudo npc-update update

对于windows

npc-update.exe update

更新完成后，执行执行sudo npc start或者npc.exe start重新运行即可完成升级

如果无法更新成功，可以直接自行下载releases压缩包然后覆盖原有的npc二进制文件

配置文件模式
此模式使用nps的公钥或者客户端私钥验证，各种配置在客户端完成，同时服务端web也可以进行管理

 ./npc -config=npc配置文件路径

配置文件说明
示例配置文件

全局配置

[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:9999

域名代理

[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=nps

tcp隧道模式

[common]
server_addr=1.1.1.1:8024
vkey=123
[tcp]
mode=tcp
target_addr=127.0.0.1:8080
server_port=9001

[common]
server_addr=1.1.1.1:8024
vkey=123
[udp]
mode=udp
target_addr=127.0.0.1:8080
server_port=9002

http代理模式

[common]
server_addr=1.1.1.1:8024
vkey=123
[http]
mode=httpProxy
server_port=9003

socks5代理模式

[common]
server_addr=1.1.1.1:8024
vkey=123
[socks5]
mode=socks5
server_port=9004
multi_account=multi_account.conf

私密代理模式

[common]
server_addr=1.1.1.1:8024
vkey=123
[secret_ssh]
mode=secret
password=ssh2
target_addr=10.1.50.2:22

p2p代理模式

[common]
server_addr=1.1.1.1:8024
vkey=123
[p2p_ssh]
mode=p2p
password=ssh2
target_addr=10.1.50.2:22

文件访问模式
利用nps提供一个公网可访问的本地文件服务，此模式仅客户端使用配置文件模式方可启动

[common]
server_addr=1.1.1.1:8024
vkey=123
[file]
mode=file
server_port=9100
local_path=/tmp/
strip_pre=/web/

对于strip_pre，访问公网ip:9100/web/相当于访问/tmp/目录

断线重连

[common]
auto_reconnection=true

使用教程

域名解析

适用范围：小程序开发、微信公众号开发、产品演示

注意：域名解析模式为http反向代理，不是dns服务器，在web上能够轻松灵活配置

假设场景：

有一个域名proxy.com，有一台公网机器ip为1.1.1.1
两个内网开发站点127.0.0.1:81，127.0.0.1:82
想通过（http|https://）a.proxy.com访问127.0.0.1:81，通过（http|https://）b.proxy.com访问127.0.0.1:82

使用步骤

将*.proxy.com解析到公网服务器1.1.1.1
点击刚才创建的客户端的域名管理，添加两条规则规则：1、域名：a.proxy.com，内网目标：127.0.0.1:81，2、域名：b.proxy.com，内网目标：127.0.0.1:82
现在访问（http|https://）a.proxy.com，b.proxy.com即可成功

https: 如需使用https请进行相关配置，详见使用https

tcp隧道

适用范围： ssh、远程桌面等tcp连接场景

假设场景：想通过访问公网服务器1.1.1.1的8001端口，连接内网机器10.1.50.101的22端口，实现ssh连接

使用步骤

在刚才创建的客户端隧道管理中添加一条tcp隧道，填写监听的端口（8001）、内网目标ip和目标端口（10.1.50.101:22），保存。
访问公网服务器ip（1.1.1.1）,填写的监听端口(8001)，相当于访问内网ip(10.1.50.101):目标端口(22)，例如：ssh -p 8001 root@1.1.1.1

udp隧道

适用范围：内网dns解析等udp连接场景

假设场景：内网有一台dns（10.1.50.102:53），在非内网环境下想使用该dns，公网服务器为1.1.1.1

使用步骤

在刚才创建的客户端的隧道管理中添加一条udp隧道，填写监听的端口（53）、内网目标ip和目标端口（10.1.50.102:53），保存。
修改需要使用的dns地址为1.1.1.1，则相当于使用10.1.50.102作为dns服务器

socks5代理

适用范围：在外网环境下如同使用vpn一样访问内网设备或者资源

假设场景：想将公网服务器1.1.1.1的8003端口作为socks5代理，达到访问内网任意设备或者资源的效果

使用步骤

在刚才创建的客户端隧道管理中添加一条socks5代理，填写监听的端口（8003），保存。
在外网环境的本机配置socks5代理(例如使用proxifier进行全局代理)，ip为公网服务器ip（1.1.1.1），端口为填写的监听端口(8003)，即可畅享内网了
注意经过socks5代理，当收到socks5数据包时socket已经是accept状态。表现是扫描端口全open，建立连接后短时间关闭。若想同内网表现一致，建议远程连接一台设备。

http正向代理

适用范围：在外网环境下使用http正向代理访问内网站点

假设场景：想将公网服务器1.1.1.1的8004端口作为http代理，访问内网网站

使用步骤

在刚才创建的客户端隧道管理中添加一条http代理，填写监听的端口（8004），保存。
在外网环境的本机配置http代理，ip为公网服务器ip（1.1.1.1），端口为填写的监听端口(8004)，即可访问了
注意：对于私密代理与p2p，除了统一配置的客户端和服务端，还需要一个客户端作为访问端提供一个端口来访问

私密代理

适用范围：无需占用多余的端口、安全性要求较高可以防止其他人连接的tcp服务，例如ssh。

假设场景：无需新增多的端口实现访问内网服务器10.1.50.2的22端口

使用步骤

在刚才创建的客户端中添加一条私密代理，并设置唯一密钥secrettest和内网目标10.1.50.2:22
在需要连接ssh的机器上以执行命令
./npc -server=1.1.1.1:8024 -vkey=vkey -type=tcp -password=secrettest -local_type=secret
Copy to clipboardErrorCopied
如需指定本地端口可加参数-local_port=xx，默认为2000

注意： password为web管理上添加的唯一密钥，具体命令可查看web管理上的命令提示

假设10.1.50.2用户名为root，现在执行ssh -p 2000 root@127.0.0.1即可访问ssh

p2p服务

适用范围：大流量传输场景，流量不经过公网服务器，但是由于p2p穿透和nat类型关系较大，不保证100%成功，支持大部分nat类型。nat类型检测

假设场景：

想通过访问使用端机器（访问端，也就是本机）的2000端口—->访问到内网机器 10.2.50.2的22端口

使用步骤

在nps.conf中设置p2p_ip（nps服务器ip）和p2p_port（nps服务器udp端口）
注：若 p2p_port 设置为6000，请在防火墙开放6000₆₀₀₂(额外添加2个端口)udp端口

在刚才刚才创建的客户端中添加一条p2p代理，并设置唯一密钥p2pssh
在使用端机器（本机）执行命令
./npc -server=1.1.1.1:8024 -vkey=123 -password=p2pssh -target=10.2.50.2:22
Copy to clipboardErrorCopied
如需指定本地端口可加参数-local_port=xx，默认为2000

注意： password为web管理上添加的唯一密钥，具体命令可查看web管理上的命令提示

假设内网机器为10.2.50.2的ssh用户名为root，现在在本机上执行ssh -p 2000 root@127.0.0.1即可访问机器2的ssh，如果是网站在浏览器访问127.0.0.1:2000端口即可。

在内网对应服务器上设置https

在nps.conf中将https_just_proxy设置为true，并且打开https_proxy_port端口，然后nps将直接转发https请求到内网服务器上，由内网服务器进行https处理

与nginx配合
有时候我们还需要在云服务器上运行nginx来保证静态文件缓存等，本代理可和nginx配合使用，在配置文件中将httpProxyPort设置为非80端口，并在nginx中配置代理，例如httpProxyPort为8010时

server {
    listen 80;
    server_name m.dfrp.ink;
    location / {
        proxy_set_header Host  $http_host;
        proxy_pass http://127.0.0.1:8010;
    }
}

如需使用https也可在nginx监听443端口并配置ssl，并将本代理的httpsProxyPort设置为空关闭https即可，例如httpProxyPort为8080时(后台端口一致)

server {
    listen 443  ssl;
    server_name  dfrp.ink;
    ssl_certificate   /fullchain.pem;       #证书公钥
    ssl_certificate_key    /privkey.pem;  #证书私钥
    ssl_session_timeout 5m;
    ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
    ssl_ciphers ECDH:AESGCM:HIGH:!RC4:!DH:!MD5:!3DES:!aNULL:!eNULL;
    ssl_prefer_server_ciphers on;
    #proxy_ssl_server_name on;

    location / {
        proxy_ssl_server_name on;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header Host $host;
        proxy_pass http://127.0.0.1:8080;  
    }
}