Skip to content

Commit

Permalink
init docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cnlh committed Dec 12, 2019
1 parent e20b1ef commit 73d7e9a
Show file tree
Hide file tree
Showing 4 changed files with 977 additions and 102 deletions.
103 changes: 1 addition & 102 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,107 +21,6 @@ nps是一款轻量级、高性能、功能强大的**内网穿透**代理服务

5. 搭建一个内网穿透ss,在外网如同使用内网vpn一样访问内网资源或者设备----> socks5代理模式


## 目录

* [安装](#安装)
* [编译安装](#源码安装)
* [release安装](#release安装)
* [docker安装](#docker安装)
* [使用示例(以web主控模式为主)](#使用示例)
* [统一准备工作](#统一准备工作(必做))
* [http|https域名解析](#域名解析)
* [内网ssh连接即tcp隧道](#tcp隧道)
* [内网dns解析即udp隧道](#udp隧道)
* [内网socks5代理](#socks5代理)
* [内网http正向代理](#http正向代理)
* [内网安全私密代理](#私密代理)
* [p2p穿透](#p2p服务)
* [简单的内网文件访问服务](#文件访问模式)
* [服务端](#web管理)
* [服务端启动](#服务端启动)
* [服务端测试](#服务端测试)
* [服务端启动](#服务端启动)
* [web管理](#web管理)
* [服务端配置文件重载](#服务端配置文件重载)
* [服务端停止或重启](#服务端停止或重启)
* [配置文件说明](#服务端配置文件)
* [使用https](#使用https)
* [与nginx配合](#与nginx配合)
* [web使用Caddy代理](#web使用Caddy代理)
* [关闭http|https代理](#关闭代理)
* [将nps安装到系统](#将nps安装到系统)
* [流量数据持久化](#流量数据持久化)
* [系统信息显示](#系统信息显示)
* [自定义客户端连接密钥](#自定义客户端连接密钥)
* [关闭公钥访问](#关闭公钥访问)
* [关闭web管理](#关闭web管理)
* [服务端多用户登陆](#服务端多用户登陆)
* [用户注册功能](#用户注册功能)
* [监听指定ip](#监听指定ip)
* [代理到服务端本地](#代理到服务端本地)
* [客户端](#客户端)
* [客户端启动](#客户端启动)
* [无配置文件模式](#无配置文件模式)
* [配置文件模式](#配置文件模式)
* [配置文件说明](#配置文件说明)
* [全局配置](#全局配置)
* [域名代理](#域名代理)
* [tcp隧道](#tcp隧道模式)
* [udp隧道](#udp隧道模式)
* [http正向代理](#http代理模式)
* [socks5代理](#socks5代理模式)
* [私密代理](#私密代理模式)
* [p2p服务](#p2p代理)
* [文件访问代理](#文件访问模式)
* [断线重连](#断线重连)
* [nat类型检测](#nat类型检测)
* [状态检查](#状态检查)
* [重载配置文件](#重载配置文件)
* [通过代理连接nps](#通过代理连接nps)
* [群晖支持](#群晖支持)

* [相关功能](#相关功能)
* [缓存支持](#缓存支持)
* [数据压缩支持](#数据压缩支持)
* [站点密码保护](#站点保护)
* [加密传输](#加密传输)
* [host修改](#host修改)
* [自定义header](#自定义header)
* [自定义404页面](#404页面配置)
* [流量限制](#流量限制)
* [带宽限制](#带宽限制)
* [负载均衡](#负载均衡)
* [端口白名单](#端口白名单)
* [端口范围映射](#端口范围映射)
* [端口范围映射到其他机器](#端口范围映射到其他机器)
* [守护进程](#守护进程)
* [KCP协议支持](#KCP协议支持)
* [域名泛解析](#域名泛解析)
* [URL路由](#URL路由)
* [限制ip访问](#限制ip访问)
* [客户端最大连接数限制](#客户端最大连接数)
* [客户端最大隧道数限制](#客户端最大隧道数限制)
* [端口复用](#端口复用)
* [多路复用](#多路复用)
* [环境变量渲染](#环境变量渲染)
* [健康检查](#健康检查)
* [日志输出](#日志输出)
* [相关说明](#相关说明)
* [流量统计](#流量统计)
* [当前客户端带宽](#当前客户端带宽)
* [热更新支持](#热更新支持)
* [获取用户真实ip](#获取用户真实ip)
* [客户端地址显示](#客户端地址显示)
* [客户端与服务端版本对比](#客户端与服务端版本对比)
* [Linux系统限制](#Linux系统限制)
* [webAPI](#webAPI)
* [贡献](#贡献)
* [支持nps发展](#捐赠)
* [交流群](#交流群)



## 安装

### release安装
Expand Down Expand Up @@ -1031,7 +930,7 @@ POST /auth/getauthkey
[webAPI文档](https://github.com/cnlh/nps/wiki/webAPI%E6%96%87%E6%A1%A3)

## 贡献
#### **欢迎参与到制作docker、图标、文档翻译等工作**
**欢迎参与到制作docker、图标、文档翻译等工作**
- 如果遇到bug可以直接提交至dev分支
- 使用遇到问题可以通过issues反馈
- 项目处于开发阶段,还有很多待完善的地方,如果可以贡献代码,请提交 PR 至 dev 分支
Expand Down
Empty file added docs/.nojekyll
Empty file.
Loading

0 comments on commit 73d7e9a

Please sign in to comment.