doc: update

This commit is contained in:
fatedier 2016-04-18 15:47:14 +08:00
parent f650d3f330
commit 14ba38a1b4
3 changed files with 10 additions and 9 deletions

View File

@ -24,7 +24,7 @@ Read the [QuickStart](doc/quick_start_en.md) | [使用文档](doc/quick_start_zh
## What can I do with frp? ## What can I do with frp?
* Expose any http service behind a NAT or firewall to the internet by a server with public IP address. * Expose any http service behind a NAT or firewall to the internet by a server with public IP address(Name-based Virtual Host Support).
* Expose any tcp service behind a NAT or firewall to the internet by a server with public IP address. * Expose any tcp service behind a NAT or firewall to the internet by a server with public IP address.
* Inspect all http requests/responses that are transmitted over the tunnel(future). * Inspect all http requests/responses that are transmitted over the tunnel(future).

View File

@ -4,13 +4,13 @@
[README](README.md) | [中文文档](README_zh.md) [README](README.md) | [中文文档](README_zh.md)
>frp 是一个高性能的反向代理应用,可以帮助你轻松的进行内网穿透,对外网提供服务。 >frp 是一个高性能的反向代理应用,可以帮助你轻松的进行内网穿透,对外网提供服务,对于 http 服务还支持虚拟主机的功能访问80端口可以根据域名路由到后端不同的 http 服务
## 开发状态 ## 开发状态
frp 目前正在前期开发阶段master分支用于发布稳定版本dev分支用于开发您可以尝试下载最新的 release 版本进行测试。 frp 目前正在前期开发阶段master分支用于发布稳定版本dev分支用于开发您可以尝试下载最新的 release 版本进行测试。
**在 1.x 版本以前,交互协议都可能会被改变,不能保证向后兼容。** **在 1.0 版本以前,交互协议都可能会被改变,不能保证向后兼容。**
## 快速开始 ## 快速开始
@ -22,13 +22,14 @@ frp 目前正在前期开发阶段master分支用于发布稳定版本dev
## frp 的作用? ## frp 的作用?
* 利用处于内网或防火墙后的机器对外网环境提供http服务。针对http的优化正在开发中 * 利用处于内网或防火墙后的机器,对外网环境提供 http 服务
* 利用处于内网或防火墙后的机器对外网环境提供tcp服务。 * 对于 http 服务支持基于域名的虚拟主机支持自定义域名绑定使多个域名可以共用一个80端口。
* 可查看通过代理的所有http请求和响应信息。待开发 * 利用处于内网或防火墙后的机器,对外网环境提供 tcp 服务,例如在家里通过 ssh 访问公司局域网内的主机。
* 可查看通过代理的所有 http 请求和响应的详细信息。(待开发)
## 贡献代码 ## 贡献代码
如果您对这个项目感兴趣,并且想要参与其中,我们非常欢迎! 如果您对这个项目感兴趣,我们非常欢迎您参与其中
* 如果您需要提交问题,可以通过 [issues](https://github.com/fatedier/frp/issues) 来完成。 * 如果您需要提交问题,可以通过 [issues](https://github.com/fatedier/frp/issues) 来完成。
* 如果您有新的功能需求,可以反馈至 fatedier@gmail.com 共同讨论。 * 如果您有新的功能需求,可以反馈至 fatedier@gmail.com 共同讨论。

View File

@ -41,7 +41,7 @@ log_file = ./frps.log
log_level = info log_level = info
# test 为代理的自定义名称可以有多个不能重复和frpc中名称对应 # test 为代理的自定义名称可以有多个不能重复和frpc中名称对应
[test] [ssh]
auth_token = 123 auth_token = 123
bind_addr = 0.0.0.0 bind_addr = 0.0.0.0
# 最后将通过此端口访问后端服务 # 最后将通过此端口访问后端服务
@ -61,7 +61,7 @@ log_level = info
auth_token = 123 auth_token = 123
# test需要和 frps.ini 中配置一致 # test需要和 frps.ini 中配置一致
[test] [ssh]
# 需要转发的本地端口 # 需要转发的本地端口
local_port = 22 local_port = 22
# 启用加密frpc与frps之间通信加密默认为 false # 启用加密frpc与frps之间通信加密默认为 false