From c759ceff4993317ae0b0809fdd924ff2e4e06090 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=88=98=E6=B2=B3?= Date: Fri, 13 Dec 2019 08:57:00 +0800 Subject: [PATCH] cahnge md --- README.md | 19 +++++++++------ docs/_coverpage.md | 2 +- docs/_sidebar.md | 3 ++- docs/api.md | 10 ++++---- docs/contribute.md | 2 +- docs/description.md | 15 ++++++------ docs/donate.md | 6 +++-- docs/example.md | 21 +++++++++-------- docs/feature.md | 54 +++++++++++++++++++++--------------------- docs/install.md | 16 +++++++------ docs/npc_extend.md | 12 +++++----- docs/nps_extend.md | 55 +++++++++++++------------------------------ docs/nps_use.md | 57 +++++++++++++++++++++++++++++++++++++++++++++ docs/run.md | 20 ++++++++++++++++ docs/start.md | 33 -------------------------- docs/use.md | 27 ++++++++++----------- 16 files changed, 193 insertions(+), 159 deletions(-) create mode 100644 docs/nps_use.md create mode 100644 docs/run.md delete mode 100644 docs/start.md diff --git a/README.md b/README.md index 6bc709e..d181930 100644 --- a/README.md +++ b/README.md @@ -27,21 +27,26 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务 下载对应的系统版本即可，服务端和客户端是单独的 - ### 服务端启动 -- 进入服务端启动 +1. 进入服务端启动 ```shell ./nps ``` 如有错误修改配置文件相应端口，无错误可继续进行下去 -- 进入WEB管理 -- 访问服务端ip:web服务端口（默认为8024） -- 在web中创建客户端 +2. 访问服务端ip:web服务端口（默认为8024） +3. 使用用户名和密码登陆（默认admin/123，正式使用一定要更改） +4. 在web中创建客户端 ### 客户端连接 -- 点击web管理中客户端前的+号，复制启动命令 -- 执行启动命令，linux直接执行即可，windows将./npc换成npc.exe用cmd执行 +1. 点击web管理中客户端前的+号，复制启动命令 +2. 执行启动命令，linux直接执行即可，windows将./npc换成npc.exe用cmd执行 ### 配置 - 客户端连接后，在web中配置对应穿透服务即可 - 更多高级用法见[完整文档](https://cnlh.github.io/nps/) + +## 贡献 +- 如果遇到bug可以直接提交至dev分支 +- 使用遇到问题可以通过issues反馈 +- 项目处于开发阶段，还有很多待完善的地方，如果可以贡献代码，请提交 PR 至 dev 分支 +- 如果有新的功能特性反馈，可以通过issues或者qq群反馈 diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 53d5a88..f74428e 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -11,4 +11,4 @@ [GitHub](https://github.com/cnlh/nps/) -[开始使用](#docsify) +[开始使用](#nps) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 7250ad2..cfb58fa 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,9 +1,10 @@ * 入门 * [安装](install.md) + * [启动](run.md) * [使用示例](example.md) * 服务端 * [介绍](introduction.md) - * [启动](start.md) + * [使用](nps_use.md) * [配置文件](server_config.md) * [增强功能](nps_extend.md) diff --git a/docs/api.md b/docs/api.md index eff6be3..2b11650 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,5 +1,5 @@ - -# webAPI验证说明 +# web api +## webAPI验证说明 - 采用auth_key的验证方式 - 在提交的每个请求后面附带两个参数，`auth_key` 和`timestamp` @@ -17,14 +17,14 @@ curl --request POST \ ``` **注意：** 为保证安全，时间戳的有效范围为20秒内，所以每次提交请求必须重新生成。 -# 获取服务端时间 +## 获取服务端时间 由于服务端与api请求的客户端时间差异不能太大，所以提供了一个可以获取服务端时间的接口 ``` POST /auth/gettime ``` -# 获取服务端authKey +## 获取服务端authKey 如果想获取authKey，服务端提供获取authKey的接口 @@ -39,7 +39,7 @@ POST /auth/getauthkey - 补码方式pkcs5padding - 解密串编码方式 十六进制 -# 详细文档 +## 详细文档 - **此文档近期可能更新较慢，建议自行抓包** 为方便第三方扩展，在web模式下可利用webAPI进行相关操作，详情见 diff --git a/docs/contribute.md b/docs/contribute.md index 35d5873..fc6e3d3 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -1,5 +1,5 @@ # 贡献 -**欢迎参与到制作docker、图标、文档翻译等工作** + - 如果遇到bug可以直接提交至dev分支 - 使用遇到问题可以通过issues反馈 - 项目处于开发阶段，还有很多待完善的地方，如果可以贡献代码，请提交 PR 至 dev 分支 diff --git a/docs/description.md b/docs/description.md index 61a568f..0520ad6 100644 --- a/docs/description.md +++ b/docs/description.md @@ -1,25 +1,26 @@ -# 获取用户真实ip +# 说明 +## 获取用户真实ip 在域名代理模式中，可以通过request请求 header 中的 X-Forwarded-For 和 X-Real-IP 来获取用户真实 IP。 **本代理前会在每一个http(s)请求中添加了这两个 header。** -# 热更新支持 +## 热更新支持 对于绝大多数配置，在web管理中的修改将实时使用，无需重启客户端或者服务端 -# 客户端地址显示 +## 客户端地址显示 在web管理中将显示客户端的连接地址 -# 流量统计 +## 流量统计 可统计显示每个代理使用的流量，由于压缩和加密等原因，会和实际环境中的略有差异 -# 当前客户端带宽 +## 当前客户端带宽 可统计每个客户端当前的带宽，可能和实际有一定差异，仅供参考。 -# 客户端与服务端版本对比 +## 客户端与服务端版本对比 为了程序正常运行，客户端与服务端的核心版本必须一致，否则将导致客户端无法成功连接致服务端。 -# Linux系统限制 +## Linux系统限制 默认情况下linux对连接数量有限制，对于性能好的机器完全可以调整内核参数以处理更多的连接。 `tcp_max_syn_backlog` `somaxconn` 酌情调整参数，增强网络性能 diff --git a/docs/donate.md b/docs/donate.md index 5fbb408..551e1eb 100644 --- a/docs/donate.md +++ b/docs/donate.md @@ -1,5 +1,7 @@ +# 捐助 如果您觉得nps对你有帮助，欢迎给予我们一定捐助，也是帮助nps更好的发展。 -# 支付宝 + +## 支付宝 ![image](https://github.com/cnlh/nps/blob/master/image/donation_zfb.png?raw=true) -# 微信 +## 微信 ![image](https://github.com/cnlh/nps/blob/master/image/donation_wx.png?raw=true) diff --git a/docs/example.md b/docs/example.md index 5980b06..e37c1f6 100644 --- a/docs/example.md +++ b/docs/example.md @@ -1,4 +1,5 @@ -# 统一准备工作（必做） +# 使用示例 +## 统一准备工作（必做） - 开启服务端，假设公网服务器ip为1.1.1.1，配置文件中`bridge_port`为8284，配置文件中`web_port`为8080 - 访问1.1.1.1:8080 - 在客户端管理中创建一个客户端，记录下验证密钥 @@ -9,7 +10,7 @@ ``` **注意：运行服务端后，请确保能从客户端设备上正常访问配置文件中所配置的`bridge_port`端口，telnet，netcat这类的来检查** -# 域名解析 +## 域名解析 **适用范围：** 小程序开发、微信公众号开发、产品演示 @@ -24,9 +25,9 @@ 现在访问（http|https://）`a.proxy.com`，`b.proxy.com`即可成功 -**https:** 如需使用https请进行相关配置，详见 [使用https](#使用https) +**https:** 如需使用https请进行相关配置，详见 [使用https](##使用https) -# tcp隧道 +## tcp隧道 **适用范围：** ssh、远程桌面等tcp连接场景 @@ -38,7 +39,7 @@ - 在刚才创建的客户端隧道管理中添加一条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隧道 +## udp隧道 **适用范围：** 内网dns解析等udp连接场景 @@ -49,7 +50,7 @@ - 在刚才创建的客户端的隧道管理中添加一条udp隧道，填写监听的端口（53）、内网目标ip和目标端口（10.1.50.102:53），保存。 - 修改需要使用的dns地址为1.1.1.1，则相当于使用10.1.50.102作为dns服务器 -# socks5代理 +## socks5代理 **适用范围：** 在外网环境下如同使用vpn一样访问内网设备或者资源 @@ -64,7 +65,7 @@ **注意** 经过socks5代理，当收到socks5数据包时socket已经是accept状态。表现是扫描端口全open，建立连接后短时间关闭。若想同内网表现一致，建议远程连接一台设备。 -# http正向代理 +## http正向代理 **适用范围：** 在外网环境下使用http正向代理访问内网站点 @@ -76,7 +77,7 @@ - 在刚才创建的客户端隧道管理中添加一条http代理，填写监听的端口（8004），保存。 - 在外网环境的本机配置http代理，ip为公网服务器ip（1.1.1.1），端口为填写的监听端口(8004)，即可访问了 -# 私密代理 +## 私密代理 **适用范围：** 无需占用多余的端口、安全性要求较高可以防止其他人连接的tcp服务，例如ssh。 @@ -97,9 +98,9 @@ 假设10.1.50.2用户名为root，现在执行`ssh -p 2000 root@1.1.1.1`即可访问ssh -# p2p服务 +## p2p服务 -**适用范围：** 大流量传输场景，流量不经过公网服务器，但是由于p2p穿透和nat类型关系较大，不保证100%成功，支持大部分nat类型。[nat类型检测](#nat类型检测) +**适用范围：** 大流量传输场景，流量不经过公网服务器，但是由于p2p穿透和nat类型关系较大，不保证100%成功，支持大部分nat类型。[nat类型检测](##nat类型检测) **假设场景：** diff --git a/docs/feature.md b/docs/feature.md index c4f6a96..b223f76 100644 --- a/docs/feature.md +++ b/docs/feature.md @@ -1,10 +1,10 @@ - -# 缓存支持 +# 扩展功能 +## 缓存支持 对于web站点来说，一些静态文件往往消耗更大的流量，且在内网穿透中，静态文件还需到客户端获取一次，这将导致更大的流量消耗。nps在域名解析代理中支持对静态文件进行缓存。 即假设一个站点有a.css，nps将只需从npc客户端读取一次该文件，然后把该文件的内容放在内存中，下一次将不再对npc客户端进行请求而直接返回内存中的对应内容。该功能默认是关闭的，如需开启请在`nps.conf`中设置`http_cache=true`，并设置`http_cache_length`（缓存文件的个数，消耗内存，不宜过大，0表示不限制个数） -# 数据压缩支持 +## 数据压缩支持 由于是内网穿透，内网客户端与服务端之间的隧道存在大量的数据交换，为节省流量，加快传输速度，由此本程序支持SNNAPY形式的压缩。 @@ -13,7 +13,7 @@ - 在web管理或客户端配置文件中设置 -# 加密传输 +## 加密传输 如果公司内网防火墙对外网访问进行了流量识别与屏蔽，例如禁止了ssh协议等，通过设置 配置文件，将服务端与客户端之间的通信内容加密传输，将会有效防止流量被拦截。 - nps使用tls加密，所以一定要保留conf目录下的密钥文件，同时也可以自行生成 @@ -21,45 +21,45 @@ -# 站点保护 +## 站点保护 域名代理模式所有客户端共用一个http服务端口，在知道域名后任何人都可访问，一些开发或者测试环境需要保密，所以可以设置用户名和密码，nps将通过 Http Basic Auth 来保护，访问时需要输入正确的用户名和密码。 - 在web管理或客户端配置文件中设置 -# host修改 +## host修改 由于内网站点需要的host可能与公网域名不一致，域名代理支持host修改功能，即修改request的header中的host字段。 **使用方法：在web管理中设置** -# 自定义header +## 自定义header 支持对header进行新增或者修改，以配合服务的需要 -# 404页面配置 +## 404页面配置 支持域名解析模式的自定义404页面，修改/web/static/page/error.html中内容即可，暂不支持静态文件等内容 -# 流量限制 +## 流量限制 支持客户端级流量限制，当该客户端入口流量与出口流量达到设定的总量后会拒绝服务 ，域名代理会返回404页面，其他代理会拒绝连接,使用该功能需要在`nps.conf`中设置`allow_flow_limit`，默认是关闭的。 -# 带宽限制 +## 带宽限制 支持客户端级带宽限制，带宽计算方式为入口和出口总和，权重均衡,使用该功能需要在`nps.conf`中设置`allow_rate_limit`，默认是关闭的。 -# 负载均衡 +## 负载均衡 本代理支持域名解析模式和tcp代理的负载均衡，在web域名添加或者编辑中内网目标分行填写多个目标即可实现轮训级别的负载均衡 -# 端口白名单 +## 端口白名单 为了防止服务端上的端口被滥用，可在nps.conf中配置allow_ports限制可开启的端口，忽略或者不填表示端口不受限制，格式： ```ini allow_ports=9001-9009,10001,11000-12000 ``` -# 端口范围映射 +## 端口范围映射 当客户端以配置文件的方式启动时，可以将本地的端口进行范围映射，仅支持tcp和udp模式，例如： ```ini @@ -70,7 +70,7 @@ target_port=8001-8009,10002,13000-14000 ``` 逗号分隔，可单个或者范围，注意上下端口的对应关系，无法一一对应将不能成功 -# 端口范围映射到其他机器 +## 端口范围映射到其他机器 ```ini [tcp] mode=tcp @@ -79,7 +79,7 @@ target_port=8001-8009,10002,13000-14000 target_ip=10.1.50.2 ``` 填写target_ip后则表示映射的该地址机器的端口，忽略则便是映射本地127.0.0.1,仅范围映射时有效 -# 守护进程 +## 守护进程 本代理支持守护进程，使用示例如下，服务端客户端所有模式通用,支持linux，darwin，windows。 ``` ./(nps|npc) start|stop|restart|status 若有其他参数可加其他参数 @@ -87,17 +87,17 @@ target_ip=10.1.50.2 ``` (nps|npc).exe start|stop|restart|status 若有其他参数可加其他参数 ``` -# KCP协议支持 +## KCP协议支持 KCP 是一个快速可靠协议，能以比 TCP浪费10%-20%的带宽的代价，换取平均延迟降低 30%-40%，在弱网环境下对性能能有一定的提升。可在nps.conf中修改`bridge_type`为kcp ，设置后本代理将开启udp端口（`bridge_port`） 注意：当服务端为kcp时，客户端连接时也需要使用相同配置，无配置文件模式加上参数type=kcp,配置文件模式在配置文件中设置tp=kcp -# 域名泛解析 +## 域名泛解析 支持域名泛解析，例如将host设置为*.proxy.com，a.proxy.com、b.proxy.com等都将解析到同一目标，在web管理中或客户端配置文件中将host设置为此格式即可。 -# URL路由 +## URL路由 本代理支持根据URL将同一域名转发到不同的内网服务器，可在web中或客户端配置文件中设置，此参数也可忽略，例如在客户端配置文件中 ```ini @@ -112,7 +112,7 @@ location=/static ``` 对于`a.proxy.com/test`将转发到`web1`，对于`a.proxy.com/static`将转发到`web2` -# 限制ip访问 +## 限制ip访问 如果将一些危险性高的端口例如ssh端口暴露在公网上，可能会带来一些风险，本代理支持限制ip访问。 **使用方法:** 在配置文件nps.conf中设置`ip_limit`=true，设置后仅通过注册的ip方可访问。 @@ -133,18 +133,18 @@ time为有效小时数，例如time=2，在当前时间后的两小时内，本 **注意：** 本机公网ip并不是一成不变的，请自行注意有效期的设置，同时同一网络下，多人也可能是在公用同一个公网ip。 -# 客户端最大连接数 +## 客户端最大连接数 为防止恶意大量长连接，影响服务端程序的稳定性，可以在web或客户端配置文件中为每个客户端设置最大连接数。该功能针对`socks5`、`http正向代理`、`域名代理`、`tcp代理`、`udp代理`、`私密代理`生效,使用该功能需要在`nps.conf`中设置`allow_connection_num_limit=true`，默认是关闭的。 -# 客户端最大隧道数限制 +## 客户端最大隧道数限制 nps支持对客户端的隧道数量进行限制，该功能默认是关闭的，如需开启，请在`nps.conf`中设置`allow_tunnel_num_limit=true`。 -# 端口复用 +## 端口复用 在一些严格的网络环境中，对端口的个数等限制较大，nps支持强大端口复用功能。将`bridge_port`、 `http_proxy_port`、 `https_proxy_port` 、`web_port`都设置为同一端口，也能正常使用。 - 使用时将需要复用的端口设置为与`bridge_port`一致即可，将自动识别。 - 如需将web管理的端口也复用，需要配置`web_host`也就是一个二级域名以便区分 -# 多路复用 +## 多路复用 nps主要通信默认基于多路复用，无需开启。 @@ -154,14 +154,14 @@ nps主要通信默认基于多路复用，无需开启。 在Linux上，可以通过调节内核参数来适应不同应用场景。 对于需求大带宽又有一定的丢包的场景，可以保持默认参数不变，尽可能少抛弃连接 -高并发下可根据[Linux系统限制](# Linux系统限制) 调整 +高并发下可根据[Linux系统限制](## Linux系统限制) 调整 对于延迟敏感而又有一定丢包的场景，可以适当调整TCP重传次数 `tcp_syn_retries`, `tcp_retries1`, `tcp_retries2` 高并发同上 nps会在系统主动关闭连接的时候拿到报错，进而重新建立隧道连接 -# 环境变量渲染 +## 环境变量渲染 npc支持环境变量渲染以适应在某些特殊场景下的要求。 **在无配置文件启动模式下：** @@ -185,7 +185,7 @@ target_addr={{.NPC_WEB_TARGET}} ``` 在配置文件中填入相应的环境变量名称，npc将自动进行渲染配置文件替换环境变量 -# 健康检查 +## 健康检查 当客户端以配置文件模式启动时，支持多节点的健康检查。配置示例如下 @@ -223,7 +223,7 @@ health_check_target | 健康检查目标，多个以逗号（,）分隔 health_check_type | 健康检查类型 health_http_url | 健康检查url，仅http模式适用 -# 日志输出 +## 日志输出 日志输出级别 diff --git a/docs/install.md b/docs/install.md index 83b081a..09313e6 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,17 +1,19 @@ -#release安装 -> [releases](https://github.com/cnlh/nps/releases) +# 安装 +## 安装包安装 + [releases](https://github.com/cnlh/nps/releases) 下载对应的系统版本即可，服务端和客户端是单独的 -# 源码安装 +## 源码安装 - 安装源码 -> go get -u github.com/cnlh/nps... +```go get -u github.com/cnlh/nps... +``` - 编译 -> go build cmd/nps/nps.go +服务端```go build cmd/nps/nps.go``` -> go build cmd/npc/npc.go +客户端```go build cmd/npc/npc.go``` -# docker安装 +## docker安装 > [server](https://hub.docker.com/r/ffdfgdfg/nps) > [client](https://hub.docker.com/r/ffdfgdfg/npc) diff --git a/docs/npc_extend.md b/docs/npc_extend.md index a757f34..ac1c6b2 100644 --- a/docs/npc_extend.md +++ b/docs/npc_extend.md @@ -1,19 +1,19 @@ - -# nat类型检测 +# 增强功能 +## nat类型检测 ``` ./npc nat ``` 如果p2p双方都是Symmetric Nat，肯定不能成功，其他组合都有较大成功率。 -# 状态检查 +## 状态检查 ``` ./npc status -config=npc配置文件路径 ``` -# 重载配置文件 +## 重载配置文件 ``` ./npc restart -config=npc配置文件路径 ``` -# 通过代理连接nps +## 通过代理连接nps 有时候运行npc的内网机器无法直接访问外网，此时可以可以通过socks5代理连接nps 对于配置文件方式启动,设置 @@ -32,5 +32,5 @@ proxy_url=socks5://111:222@127.0.0.1:8024 或http://username:password@ip:port -# 群晖支持 +## 群晖支持 可在releases中下载spk群晖套件，例如`npc_x64-6.1_0.19.0-1.spk` diff --git a/docs/nps_extend.md b/docs/nps_extend.md index 2b6d339..e15ca8e 100644 --- a/docs/nps_extend.md +++ b/docs/nps_extend.md @@ -1,5 +1,5 @@ - -# 使用https +# 增强功能 +## 使用https **方式一：** 类似于nginx实现https的处理 @@ -12,7 +12,7 @@ 在`nps.conf`中将`https_just_proxy`设置为true，并且打开`https_proxy_port`端口，然后nps将直接转发https请求到内网服务器上，由内网服务器进行https处理 -# 与nginx配合 +## 与nginx配合 有时候我们还需要在云服务器上运行nginx来保证静态文件缓存等，本代理可和nginx配合使用，在配置文件中将httpProxyPort设置为非80端口，并在nginx中配置代理，例如httpProxyPort为8024时 ``` @@ -45,7 +45,7 @@ server { } ``` -# web使用Caddy代理 +## web使用Caddy代理 如果将web配置到Caddy代理,实现子路径访问nps,可以这样配置. @@ -53,8 +53,8 @@ server { ```Caddyfile caddy_ip:caddy_port/nps { - #server_ip 为 nps 服务器IP - #web_port 为 nps 后台端口 + ##server_ip 为 nps 服务器IP + ##web_port 为 nps 后台端口 proxy / http://server_ip:web_port/nps { transparent } @@ -67,61 +67,38 @@ web_base_url=/nps ``` -# 关闭代理 +## 关闭代理 如需关闭http代理可在配置文件中将http_proxy_port设置为空，如需关闭https代理可在配置文件中将https_proxy_port设置为空。 -# 将nps安装到系统 -如果需要长期并且方便的运行nps服务端，可将nps安装到操作系统中，可执行命令 - -``` -(./nps|nps.exe) install -``` -安装成功后，对于linux，darwin，将会把配置文件和静态文件放置于/etc/nps/，并将可执行文件nps复制到/usr/bin/nps或者/usr/local/bin/nps，安装成功后可在任何位置执行，同时也会添加systemd配置。 - -``` -sudo systemctl enable|disable|start|stop|restart|status nps -``` -systemd，带有开机自启，自动重启配置，当进程结束后15秒会启动，日志输出至/var/log/nps/nps.log。 -建议采用此方式启动，能够捕获panic信息，便于排查问题。 - -``` -nps test|start|stop|restart|status -``` -对于windows系统，将会把配置文件和静态文件放置于C:\Program Files\nps，安装成功后可将可执行文件nps.exe复制到任何位置执行 - -``` -nps.exe test|start|stop|restart|status -``` - -# 流量数据持久化 +## 流量数据持久化 服务端支持将流量数据持久化，默认情况下是关闭的，如果有需求可以设置`nps.conf`中的`flow_store_interval`参数，单位为分钟 **注意：** nps不会持久化通过公钥连接的客户端 -# 系统信息显示 +## 系统信息显示 nps服务端支持在web上显示和统计服务器的相关信息，但默认一些统计图表是关闭的，如需开启请在`nps.conf`中设置`system_info_display=true` -# 自定义客户端连接密钥 +## 自定义客户端连接密钥 web上可以自定义客户端连接的密钥，但是必须具有唯一性 -# 关闭公钥访问 +## 关闭公钥访问 可以将`nps.conf`中的`public_vkey`设置为空或者删除 -# 关闭web管理 +## 关闭web管理 可以将`nps.conf`中的`web_port`设置为空或者删除 -# 服务端多用户登陆 +## 服务端多用户登陆 如果将`nps.conf`中的`allow_user_login`设置为true,服务端web将支持多用户登陆，登陆用户名为user，默认密码为每个客户端的验证密钥，登陆后可以进入客户端编辑修改web登陆的用户名和密码，默认该功能是关闭的。 -# 用户注册功能 +## 用户注册功能 nps服务端支持用户注册功能，可将`nps.conf`中的`allow_user_register`设置为true，开启后登陆页将会有有注册功能， -# 监听指定ip +## 监听指定ip nps支持每个隧道监听不同的服务端端口,在`nps.conf`中设置`allow_multi_ip=true`后，可在web中控制，或者npc配置文件中(可忽略，默认为0.0.0.0) ```ini server_ip=xxx ``` -# 代理到服务端本地 +## 代理到服务端本地 在使用nps监听80或者443端口时，默认是将所有的请求都会转发到内网上，但有时候我们的nps服务器的上一些服务也需要使用这两个端口，nps提供类似于`nginx` `proxy_pass` 的功能，支持将代理到服务器本地，该功能支持域名解析，tcp、udp隧道，默认关闭。 **即：** 假设在nps的vps服务器上有一个服务使用5000端口，这时候nps占用了80端口和443，我们想能使用一个域名通过http(s)访问到5000的服务。 diff --git a/docs/nps_use.md b/docs/nps_use.md new file mode 100644 index 0000000..1985811 --- /dev/null +++ b/docs/nps_use.md @@ -0,0 +1,57 @@ +**提示：使用web模式时，服务端执行文件必须在项目根目录，否则无法正确加载配置文件** + + +# 服务端测试 +```shell + ./nps test +``` +如有错误请及时修改配置文件，无错误可继续进行下去 +# 服务端启动 +```shell + ./nps start +``` +**如果无需daemon运行或者打开后无法正常访问web管理，去掉start查看日志运行即可** + +# web管理 + +进入web界面，公网ip:web界面端口（默认8080），密码默认为123 + +进入web管理界面，有详细的说明 + +# 服务端配置文件重载 +如果是daemon启动 +```shell + ./nps reload +``` +**说明：** 仅支持部分配置重载，例如`allow_user_login` `auth_crypt_key` `auth_key` `web_username` `web_password` 等，未来将支持更多 + + +# 服务端停止或重启 +如果是daemon启动 +```shell + ./nps stop|restart +``` + +# 将nps安装到系统 +如果需要长期并且方便的运行nps服务端，可将nps安装到操作系统中，可执行命令 + +``` +(./nps|nps.exe) install +``` +安装成功后，对于linux，darwin，将会把配置文件和静态文件放置于/etc/nps/，并将可执行文件nps复制到/usr/bin/nps或者/usr/local/bin/nps，安装成功后可在任何位置执行，同时也会添加systemd配置。 + +``` +sudo systemctl enable|disable|start|stop|restart|status nps +``` +systemd，带有开机自启，自动重启配置，当进程结束后15秒会启动，日志输出至/var/log/nps/nps.log。 +建议采用此方式启动，能够捕获panic信息，便于排查问题。 + +``` +nps test|start|stop|restart|status +``` +对于windows系统，将会把配置文件和静态文件放置于C:\Program Files\nps，安装成功后可将可执行文件nps.exe复制到任何位置执行 + +``` +nps.exe test|start|stop|restart|status +``` + diff --git a/docs/run.md b/docs/run.md new file mode 100644 index 0000000..c0aec66 --- /dev/null +++ b/docs/run.md @@ -0,0 +1,20 @@ +# 启动 +## 服务端 +下载完服务器压缩包后，解压，然后进入解压后的文件夹 +1. 执行命令启动 +```shell + ./nps +``` +**如有错误（E）修改配置文件相应端口**，无错误可继续进行下去 +2. 访问服务端ip:web服务端口（默认为8024） +3. 使用用户名和密码登陆（默认admin/123，正式使用一定要更改） +4. 创建客户端 + +## 客户端 +1. 下载客户端安装包并解压，进入到解压目录 +1. 点击web管理中客户端前的+号，复制启动命令 +2. 执行启动命令，linux直接执行即可，windows将./npc换成npc.exe用cmd执行 + +## 配置 +- 客户端连接后，在web中配置对应穿透服务即可 +- 可以查看[使用示例](/example) diff --git a/docs/start.md b/docs/start.md deleted file mode 100644 index fc82d13..0000000 --- a/docs/start.md +++ /dev/null @@ -1,33 +0,0 @@ -**提示：使用web模式时，服务端执行文件必须在项目根目录，否则无法正确加载配置文件** - - -# 服务端测试 -```shell - ./nps test -``` -如有错误请及时修改配置文件，无错误可继续进行下去 -# 服务端启动 -```shell - ./nps start -``` -**如果无需daemon运行或者打开后无法正常访问web管理，去掉start查看日志运行即可** - -# web管理 - -进入web界面，公网ip:web界面端口（默认8080），密码默认为123 - -进入web管理界面，有详细的说明 - -# 服务端配置文件重载 -如果是daemon启动 -```shell - ./nps reload -``` -**说明：** 仅支持部分配置重载，例如`allow_user_login` `auth_crypt_key` `auth_key` `web_username` `web_password` 等，未来将支持更多 - - -# 服务端停止或重启 -如果是daemon启动 -```shell - ./nps stop|restart -``` diff --git a/docs/use.md b/docs/use.md index cb4f88f..183d41e 100644 --- a/docs/use.md +++ b/docs/use.md @@ -1,9 +1,10 @@ -# 无配置文件模式 +# 基本使用 +## 无配置文件模式 此模式的各种配置在服务端web管理中完成,客户端除运行一条命令外无需任何其他设置 ``` ./npc -server=ip:port -vkey=web界面中显示的密钥 ``` -# 配置文件模式 +## 配置文件模式 此模式使用nps的公钥或者客户端私钥验证，各种配置在客户端完成，同时服务端web也可以进行管理 ``` ./npc -config=npc配置文件路径 @@ -29,9 +30,9 @@ ExecStart=/absolutely path to/npc -server=ip:port -vkey=web界面中显示的密 [Install] WantedBy=multi-user.target ``` -# 配置文件说明 +## 配置文件说明 [示例配置文件](https://github.com/cnlh/nps/tree/master/conf/npc.conf) -## 全局配置 +#### 全局配置 ```ini [common] server_addr=1.1.1.1:8284 @@ -59,7 +60,7 @@ rate_limit|速度限制，可忽略 flow_limit|流量限制，可忽略 remark|客户端备注，可忽略 max_conn|最大连接数，可忽略 -## 域名代理 +#### 域名代理 ```ini [common] @@ -79,7 +80,7 @@ target_addr|内网目标，负载均衡时多个目标，逗号隔开 host_change|请求host修改 header_xxx|请求header修改或添加，header_proxy表示添加header proxy:nps -## tcp隧道模式 +#### tcp隧道模式 ```ini [common] @@ -96,7 +97,7 @@ mode | tcp server_port | 在服务端的代理端口 tartget_addr|内网目标 -## udp隧道模式 +#### udp隧道模式 ```ini [common] @@ -112,7 +113,7 @@ server_port=9002 mode | udp server_port | 在服务端的代理端口 target_addr|内网目标 -## http代理模式 +#### http代理模式 ```ini [common] @@ -126,7 +127,7 @@ server_port=9003 ---|--- mode | httpProxy server_port | 在服务端的代理端口 -## socks5代理模式 +#### socks5代理模式 ```ini [common] @@ -142,7 +143,7 @@ multi_account=multi_account.conf mode | socks5 server_port | 在服务端的代理端口 multi_account | socks5多账号配置文件（可选),配置后使用basic_username和basic_password无法通过认证 -## 私密代理模式 +#### 私密代理模式 ```ini [common] @@ -159,7 +160,7 @@ mode | secret password | 唯一密钥 target_addr|内网目标 -## p2p代理模式 +#### p2p代理模式 ```ini [common] @@ -177,7 +178,7 @@ password | 唯一密钥 target_addr|内网目标 -## 文件访问模式 +#### 文件访问模式 利用nps提供一个公网可访问的本地文件服务，此模式仅客户端使用配置文件模式方可启动 ```ini @@ -200,7 +201,7 @@ strip_pre|前缀 对于`strip_pre`，访问公网`ip:9100/web/`相当于访问`/tmp/`目录 -## 断线重连 +#### 断线重连 ```ini [common] auto_reconnection=true