Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
刘河 committed Mar 26, 2019
1 parent 5beee73 commit 69e60a3
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务
* [服务端测试](#服务端测试)
* [服务端启动](#服务端启动)
* [web管理](#web管理)
* [服务端配置文件重载](#服务端配置文件重载)
* [服务端停止或重启](#服务端停止或重启)
* [配置文件说明](#服务端配置文件)

Expand All @@ -51,6 +52,7 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务
* [自定义客户端连接密钥](#自定义客户端连接密钥)
* [关闭公钥访问](#关闭公钥访问)
* [关闭web管理](#关闭web管理)
* [服务端多用户登陆](#服务端多用户登陆)
* [客户端](#客户端)
* [客户端启动](#客户端启动)
* [无配置文件模式](#无配置文件模式)
Expand Down Expand Up @@ -96,6 +98,7 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务

* [相关说明](#相关说明)
* [流量统计](#流量统计)
* [当前客户端带宽](#当前客户端带宽)
* [热更新支持](#热更新支持)
* [获取用户真实ip](#获取用户真实ip)
* [客户端地址显示](#客户端地址显示)
Expand Down Expand Up @@ -285,6 +288,14 @@ port=2001

进入web管理界面,有详细的说明

#### 服务端配置文件重载
如果是daemon启动
```shell
./nps reload
```
**说明:** 仅支持部分配置重载,例如`allow_user_login` `auth_crypt_key` `auth_key` `web_username` `web_password` 等,未来将支持更多


#### 服务端停止或重启
如果是daemon启动
```shell
Expand Down Expand Up @@ -394,6 +405,10 @@ web上可以自定义客户端连接的密钥,但是必须具有唯一性
### 关闭web管理
可以将`nps.conf`中的`web_port`设置为空或者删除

### 服务端多用户登陆
如果将`nps.conf`中的`allow_user_login`设置为true,服务端web将支持多用户登陆,登陆用户名为user,密码为每个客户端的验证密钥,默认该功能是关闭的。


## 客户端

### 客户端启动
Expand Down Expand Up @@ -838,6 +853,9 @@ health_http_url | 健康检查url,仅http模式适用
### 流量统计
可统计显示每个代理使用的流量,由于压缩和加密等原因,会和实际环境中的略有差异

### 当前客户端带宽
可统计每个客户端当前的带宽,可能和实际有一定差异,仅供参考。

### 客户端与服务端版本对比
为了程序正常运行,客户端与服务端的版本必须一致,否则将导致客户端无法成功连接致服务端。

Expand Down

0 comments on commit 69e60a3

Please sign in to comment.