From d091e0eac9b17523ccdbd0550c8365070adc5903 Mon Sep 17 00:00:00 2001 From: fatedier Date: Wed, 6 Apr 2016 11:43:50 +0800 Subject: [PATCH] doc: update --- README.md | 12 +++++++++++- README_zh.md | 40 ++++++++++++++++++++++++++++++++++++++++ doc/quick_start_en.md | 7 +++++-- doc/quick_start_zh.md | 7 +++++-- 4 files changed, 61 insertions(+), 5 deletions(-) create mode 100644 README_zh.md diff --git a/README.md b/README.md index 14e81ec..3a39456 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,17 @@ [![Build Status](https://travis-ci.org/fatedier/frp.svg)](https://travis-ci.org/fatedier/frp) +[README](README.md) | [中文文档](README_zh.md) + ## What is frp? frp is a fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet. ## Status -frp is under development and you can try it with available version 0.3.0. +frp is under development and you can try it with latest release version.Master branch for releasing stable version when dev branch for developing. + +**We may change any protocol and can't promise backward compatible before version 1.x.** ## Quick Start @@ -31,3 +35,9 @@ Interested in getting involved? We would love to help you! For simple bug fixes, just submit a PR with the fix and we can discuss the fix directly in the PR. If the fix is more complex, start with an issue. If you have some wanderful ideas, send email to fatedier@gmail.com. + +## Contributors + +* [fatedier](https://github.com/fatedier) +* [Hurricanezwf](https://github.com/Hurricanezwf) +* [vashstorm](https://github.com/vashstorm) diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 0000000..e5dcd2b --- /dev/null +++ b/README_zh.md @@ -0,0 +1,40 @@ +# frp + +[![Build Status](https://travis-ci.org/fatedier/frp.svg)](https://travis-ci.org/fatedier/frp) + +[README](README.md) | [中文文档](README_zh.md) + +>frp 是一个高性能的反向代理应用，可以帮助你轻松的进行内网穿透，对外网提供服务。 + +## 开发状态 + +frp 目前正在前期开发阶段，master分支用于发布稳定版本，dev分支用于开发，您可以尝试下载最新的 release 版本进行测试。 + +**在 1.x 版本以前，交互协议都可能会被改变，不能保证向后兼容。** + +## 快速开始 + +[QuickStart](doc/quick_start_en.md) | [使用文档](doc/quick_start_zh.md) + +## 架构 + +![architecture](doc/pic/architecture.png) + +## frp 的作用? + +* 利用处于内网或防火墙后的机器，对外网环境提供http服务。（针对http的优化正在开发中） +* 利用处于内网或防火墙后的机器，对外网环境提供tcp服务。 +* 可查看通过代理的所有http请求和响应信息。（待开发） + +## 贡献代码 + +如果您对这个项目感兴趣，并且想要参与其中，我们非常欢迎！ + +* 如果您需要提交问题，可以通过 [issue](https://github.com/fatedier/frp/issues) 来完成。 +* 如果您有新的功能需求，可以反馈至 fatedier@gmail.com 共同讨论。 + +## 贡献者 + +* [fatedier](https://github.com/fatedier) +* [Hurricanezwf](https://github.com/Hurricanezwf) +* [vashstorm](https://github.com/vashstorm) diff --git a/doc/quick_start_en.md b/doc/quick_start_en.md index 46fa3c2..6b2a00c 100644 --- a/doc/quick_start_en.md +++ b/doc/quick_start_en.md @@ -44,7 +44,7 @@ log_level = info # test is the custom name of proxy and there can be many proxies with unique name in one configure file [test] -passwd = 123 +auth_token = 123 bind_addr = 0.0.0.0 # finally we connect to server A by this port listen_port = 6000 @@ -59,10 +59,13 @@ server_addr = x.x.x.x server_port = 7000 log_file = ./frpc.log log_level = info +# for authentication +auth_token = 123 # test is proxy name same with configure in frps.ini [test] -passwd = 123 # local port which need to be transferred local_port = 22 +# if use_encryption equals true, messages between frpc and frps will be encrypted, default is false +use_encryption = true ``` diff --git a/doc/quick_start_zh.md b/doc/quick_start_zh.md index 61fb3bd..f48b55d 100644 --- a/doc/quick_start_zh.md +++ b/doc/quick_start_zh.md @@ -42,7 +42,7 @@ log_level = info # test 为代理的自定义名称，可以有多个，不能重复，和frpc中名称对应 [test] -passwd = 123 +auth_token = 123 bind_addr = 0.0.0.0 # 最后将通过此端口访问后端服务 listen_port = 6000 @@ -57,10 +57,13 @@ server_addr = x.x.x.x server_port = 7000 log_file = ./frpc.log log_level = info +# 用于身份验证 +auth_token = 123 # test需要和 frps.ini 中配置一致 [test] -passwd = 123 # 需要转发的本地端口 local_port = 22 +# 启用加密，frpc与frps之间通信加密，默认为 false +use_encryption = true ```