Browse Source

change md

刘河 5 years ago
parent
commit
f70a0dab5f
3 changed files with 48 additions and 62 deletions
  1. 21 10
      README.md
  2. 5 41
      docs/nps_use.md
  3. 22 11
      docs/run.md

+ 21 - 10
README.md

@@ -28,19 +28,30 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务
 下载对应的系统版本即可,服务端和客户端是单独的
 
 ### 服务端启动
-1. 进入服务端启动
-```shell
- ./nps
-```
-如有错误修改配置文件相应端口,无错误可继续进行下去
+下载完服务器压缩包后,解压,然后进入解压后的文件夹
 
-2. 访问服务端ip:web服务端口(默认为8024)
-3. 使用用户名和密码登陆(默认admin/123,正式使用一定要更改)
-4. 在web中创建客户端
+- 执行安装命令
+
+对于linux|darwin ```sudo ./nps install```
+
+对于windows,管理员身份运行cmd,进入安装目录 ```nps.exe install```
+
+- 启动
+
+对于linux|darwin ```sudo nps start```
+
+对于windows,管理员身份运行cmd,进入程序目录 ```nps.exe start```
+
+停止和重启可用,start和restart
+
+**如果发现没有启动成功,可以查看日志(Windows日志文件位于当前运行目录下,linux和darwin位于/var/log/nps.log)**
+- 访问服务端ip:web服务端口(默认为8080)
+- 使用用户名和密码登陆(默认admin/123,正式使用一定要更改)
+- 创建客户端
 
 ### 客户端连接
-1. 点击web管理中客户端前的+号,复制启动命令
-2. 执行启动命令,linux直接执行即可,windows将./npc换成npc.exe用cmd执行
+- 点击web管理中客户端前的+号,复制启动命令
+- 执行启动命令,linux直接执行即可,windows将./npc换成npc.exe用cmd执行
 
 ### 配置
 - 客户端连接后,在web中配置对应穿透服务即可

+ 5 - 41
docs/nps_use.md

@@ -1,57 +1,21 @@
+# 使用
 **提示:使用web模式时,服务端执行文件必须在项目根目录,否则无法正确加载配置文件**
 
-
-# 服务端测试
-```shell
- ./nps test
-```
-如有错误请及时修改配置文件,无错误可继续进行下去
-# 服务端启动
-```shell
- ./nps start
-```
-**如果无需daemon运行或者打开后无法正常访问web管理,去掉start查看日志运行即可**
-
-# web管理
+## web管理
 
 进入web界面,公网ip:web界面端口(默认8080),密码默认为123
 
 进入web管理界面,有详细的说明
 
-# 服务端配置文件重载
-如果是daemon启动
+## 服务端配置文件重载
 ```shell
- ./nps reload
+ sudo 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
-```
-

+ 22 - 11
docs/run.md

@@ -1,19 +1,30 @@
 # 启动
 ## 服务端
 下载完服务器压缩包后,解压,然后进入解压后的文件夹
-1. 执行命令启动
-```shell
- ./nps
-```
-**如有错误(E)修改配置文件相应端口**,无错误可继续进行下去
-2. 访问服务端ip:web服务端口(默认为8024)
-3. 使用用户名和密码登陆(默认admin/123,正式使用一定要更改)
-4. 创建客户端
+
+- 执行安装命令
+
+对于linux|darwin ```sudo ./nps install```
+
+对于windows,管理员身份运行cmd,进入安装目录 ```nps.exe install```
+
+- 启动
+
+对于linux|darwin ```sudo nps start```
+
+对于windows,管理员身份运行cmd,进入程序目录 ```nps.exe start```
+
+停止和重启可用,start和restart
+
+**如果发现没有启动成功,可以查看日志(Windows日志文件位于当前运行目录下,linux和darwin位于/var/log/nps.log)**
+- 访问服务端ip:web服务端口(默认为8080)
+- 使用用户名和密码登陆(默认admin/123,正式使用一定要更改)
+- 创建客户端
 
 ## 客户端
-1. 下载客户端安装包并解压,进入到解压目录
-1. 点击web管理中客户端前的+号,复制启动命令
-2. 执行启动命令,linux直接执行即可,windows将./npc换成npc.exe用cmd执行
+- 下载客户端安装包并解压,进入到解压目录
+- 点击web管理中客户端前的+号,复制启动命令
+- 执行启动命令,linux直接执行即可,windows将./npc换成npc.exe用cmd执行
 
 ## 配置
 - 客户端连接后,在web中配置对应穿透服务即可