mirror of https://github.com/ehang-io/nps
change docs path
parent
6c7ac59626
commit
5d7023f055
12
README.md
12
README.md
|
@ -5,12 +5,12 @@
|
||||||
[](https://travis-ci.org/cnlh/nps)
|
[](https://travis-ci.org/cnlh/nps)
|
||||||

|

|
||||||
|
|
||||||
[README](https://github.com/cnlh/nps/blob/master/README.md)|[中文文档](https://github.com/cnlh/nps/blob/master/README_zh.md)
|
[README](https://github.com/ehang-io/nps/blob/master/README.md)|[中文文档](https://github.com/ehang-io/nps/blob/master/README_zh.md)
|
||||||
|
|
||||||
NPS is a lightweight, high-performance, powerful **intranet penetration** proxy server, with a powerful web management terminal.
|
NPS is a lightweight, high-performance, powerful **intranet penetration** proxy server, with a powerful web management terminal.
|
||||||
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Feature
|
## Feature
|
||||||
|
|
||||||
|
@ -24,13 +24,13 @@ NPS is a lightweight, high-performance, powerful **intranet penetration** proxy
|
||||||
- Domain name resolution has functions such as custom headers, 404 page configuration, host modification, site protection, URL routing, and pan-resolution.
|
- Domain name resolution has functions such as custom headers, 404 page configuration, host modification, site protection, URL routing, and pan-resolution.
|
||||||
- Multi-user and user registration support on server.
|
- Multi-user and user registration support on server.
|
||||||
|
|
||||||
**Didn't find the feature you want? It doesn't matter, click [Enter the document](https://cnlh.github.io/nps/) to find it!**
|
**Didn't find the feature you want? It doesn't matter, click [Enter the document](https://ehang-io.github.io/nps/) to find it!**
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
> [releases](https://github.com/cnlh/nps/releases)
|
> [releases](https://github.com/ehang-io/nps/releases)
|
||||||
|
|
||||||
Download the corresponding system version, the server and client are separate.
|
Download the corresponding system version, the server and client are separate.
|
||||||
|
|
||||||
|
@ -62,11 +62,11 @@ For windows, run cmd as administrator and enter the program directory ```nps.exe
|
||||||
- Click the + sign in front of the client in web management and copy the startup command.
|
- Click the + sign in front of the client in web management and copy the startup command.
|
||||||
- Execute the startup command, Linux can be executed directly, Windows will replace ./npc with npc.exe and execute it with cmd.
|
- Execute the startup command, Linux can be executed directly, Windows will replace ./npc with npc.exe and execute it with cmd.
|
||||||
|
|
||||||
If you need to register to the system service, you can check [Register to the system service](https://cnlh.github.io/nps/#/use?id=注册到系统服务)
|
If you need to register to the system service, you can check [Register to the system service](https://ehang-io.github.io/nps/#/use?id=注册到系统服务)
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
- After the client connects, configure the corresponding penetration service in the web.
|
- After the client connects, configure the corresponding penetration service in the web.
|
||||||
- For more advanced usage, see [Complete Documentation](https://cnlh.github.io/nps/)
|
- For more advanced usage, see [Complete Documentation](https://ehang-io.github.io/nps/)
|
||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
- If you encounter a bug, you can submit it to the dev branch directly.
|
- If you encounter a bug, you can submit it to the dev branch directly.
|
||||||
|
|
12
README_zh.md
12
README_zh.md
|
@ -5,13 +5,13 @@
|
||||||
[](https://travis-ci.org/cnlh/nps)
|
[](https://travis-ci.org/cnlh/nps)
|
||||||

|

|
||||||
|
|
||||||
[README](https://github.com/cnlh/nps/blob/master/README.md)|[中文文档](https://github.com/cnlh/nps/blob/master/README_zh.md)
|
[README](https://github.com/ehang-io/nps/blob/master/README.md)|[中文文档](https://github.com/ehang-io/nps/blob/master/README_zh.md)
|
||||||
|
|
||||||
nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务器。目前支持**tcp、udp流量转发**,可支持任何**tcp、udp**上层协议(访问内网网站、本地支付接口调试、ssh访问、远程桌面,内网dns解析等等……),此外还**支持内网http代理、内网socks5代理**、**p2p等**,并带有功能强大的web管理端。
|
nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务器。目前支持**tcp、udp流量转发**,可支持任何**tcp、udp**上层协议(访问内网网站、本地支付接口调试、ssh访问、远程桌面,内网dns解析等等……),此外还**支持内网http代理、内网socks5代理**、**p2p等**,并带有功能强大的web管理端。
|
||||||
|
|
||||||
|
|
||||||
## 背景
|
## 背景
|
||||||

|

|
||||||
|
|
||||||
1. 做微信公众号开发、小程序开发等----> 域名代理模式
|
1. 做微信公众号开发、小程序开发等----> 域名代理模式
|
||||||
|
|
||||||
|
@ -33,11 +33,11 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务
|
||||||
- 域名解析具备自定义header、404页面配置、host修改、站点保护、URL路由、泛解析等功能
|
- 域名解析具备自定义header、404页面配置、host修改、站点保护、URL路由、泛解析等功能
|
||||||
- 服务端支持多用户和用户注册功能
|
- 服务端支持多用户和用户注册功能
|
||||||
|
|
||||||
**没找到你想要的功能?不要紧,点击[进入文档](https://cnlh.github.io/nps/)查找吧**
|
**没找到你想要的功能?不要紧,点击[进入文档](https://ehang-io.github.io/nps)查找吧**
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
### 安装
|
### 安装
|
||||||
> [releases](https://github.com/cnlh/nps/releases)
|
> [releases](https://github.com/ehang-io/nps/releases)
|
||||||
|
|
||||||
下载对应的系统版本即可,服务端和客户端是单独的
|
下载对应的系统版本即可,服务端和客户端是单独的
|
||||||
|
|
||||||
|
@ -67,11 +67,11 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务
|
||||||
- 点击web管理中客户端前的+号,复制启动命令
|
- 点击web管理中客户端前的+号,复制启动命令
|
||||||
- 执行启动命令,linux直接执行即可,windows将./npc换成npc.exe用cmd执行
|
- 执行启动命令,linux直接执行即可,windows将./npc换成npc.exe用cmd执行
|
||||||
|
|
||||||
如果需要注册到系统服务可查看[注册到系统服务](https://cnlh.github.io/nps/#/use?id=注册到系统服务)
|
如果需要注册到系统服务可查看[注册到系统服务](https://ehang-io.github.io/nps/#/use?id=注册到系统服务)
|
||||||
|
|
||||||
### 配置
|
### 配置
|
||||||
- 客户端连接后,在web中配置对应穿透服务即可
|
- 客户端连接后,在web中配置对应穿透服务即可
|
||||||
- 更多高级用法见[完整文档](https://cnlh.github.io/nps/)
|
- 更多高级用法见[完整文档](https://ehang-io.github.io/nps/)
|
||||||
|
|
||||||
## 贡献
|
## 贡献
|
||||||
- 如果遇到bug可以直接提交至dev分支
|
- 如果遇到bug可以直接提交至dev分支
|
||||||
|
|
|
@ -7,7 +7,7 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务
|
||||||
|
|
||||||
|
|
||||||
## 背景
|
## 背景
|
||||||

|

|
||||||
|
|
||||||
1. 做微信公众号开发、小程序开发等----> 域名代理模式
|
1. 做微信公众号开发、小程序开发等----> 域名代理模式
|
||||||
|
|
||||||
|
|
|
@ -12,5 +12,5 @@
|
||||||
- 全平台兼容,一键注册为服务
|
- 全平台兼容,一键注册为服务
|
||||||
|
|
||||||
|
|
||||||
[GitHub](https://github.com/cnlh/nps/)
|
[GitHub](https://github.com/ehang-io/nps/)
|
||||||
[开始使用](#nps)
|
[开始使用](#nps)
|
||||||
|
|
|
@ -43,4 +43,4 @@ POST /auth/getauthkey
|
||||||
- **此文档近期可能更新较慢,建议自行抓包**
|
- **此文档近期可能更新较慢,建议自行抓包**
|
||||||
|
|
||||||
为方便第三方扩展,在web模式下可利用webAPI进行相关操作,详情见
|
为方便第三方扩展,在web模式下可利用webAPI进行相关操作,详情见
|
||||||
[webAPI文档](https://github.com/cnlh/nps/wiki/webAPI%E6%96%87%E6%A1%A3)
|
[webAPI文档](https://github.com/ehang-io/nps/wiki/webAPI%E6%96%87%E6%A1%A3)
|
||||||
|
|
|
@ -2,6 +2,6 @@
|
||||||
如果您觉得nps对你有帮助,欢迎给予我们一定捐助,也是帮助nps更好的发展。
|
如果您觉得nps对你有帮助,欢迎给予我们一定捐助,也是帮助nps更好的发展。
|
||||||
|
|
||||||
## 支付宝
|
## 支付宝
|
||||||

|

|
||||||
## 微信
|
## 微信
|
||||||

|

|
||||||
|
|
|
@ -29,7 +29,7 @@
|
||||||
hideOtherSidebarContent: true, // whether or not to hide other sidebar content
|
hideOtherSidebarContent: true, // whether or not to hide other sidebar content
|
||||||
},
|
},
|
||||||
plugins: [
|
plugins: [
|
||||||
EditOnGithubPlugin.create("https://github.com/cnlh/nps/tree/master/docs/", "", "在github上编辑"),
|
EditOnGithubPlugin.create("https://github.com/ehang-io/nps/tree/master/docs/", "", "在github上编辑"),
|
||||||
]
|
]
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,13 +1,12 @@
|
||||||
# 安装
|
# 安装
|
||||||
## 安装包安装
|
## 安装包安装
|
||||||
[releases](https://github.com/cnlh/nps/releases)
|
[releases](https://github.com/ehang-io/nps/releases)
|
||||||
|
|
||||||
下载对应的系统版本即可,服务端和客户端是单独的
|
下载对应的系统版本即可,服务端和客户端是单独的
|
||||||
|
|
||||||
## 源码安装
|
## 源码安装
|
||||||
- 安装源码
|
- 安装源码
|
||||||
```go get -u github.com/cnlh/nps...
|
```go get -u ehang.io/nps...```
|
||||||
```
|
|
||||||
- 编译
|
- 编译
|
||||||
|
|
||||||
服务端```go build cmd/nps/nps.go```
|
服务端```go build cmd/nps/nps.go```
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||

|

|
||||||
# 介绍
|
# 介绍
|
||||||
|
|
||||||
可在网页上配置和管理各个tcp、udp隧道、内网站点代理,http、https解析等,功能强大,操作方便。
|
可在网页上配置和管理各个tcp、udp隧道、内网站点代理,http、https解析等,功能强大,操作方便。
|
||||||
|
|
|
@ -44,7 +44,7 @@ npc-update.exe update
|
||||||
./npc -config=npc配置文件路径
|
./npc -config=npc配置文件路径
|
||||||
```
|
```
|
||||||
## 配置文件说明
|
## 配置文件说明
|
||||||
[示例配置文件](https://github.com/cnlh/nps/tree/master/conf/npc.conf)
|
[示例配置文件](https://github.com/ehang-io/nps/tree/master/conf/npc.conf)
|
||||||
#### 全局配置
|
#### 全局配置
|
||||||
```ini
|
```ini
|
||||||
[common]
|
[common]
|
||||||
|
|
Loading…
Reference in New Issue