From d7797cbd18d06e04ea3af4e6b976457369f533b6 Mon Sep 17 00:00:00 2001 From: fatedier Date: Tue, 19 Apr 2016 19:02:13 +0800 Subject: [PATCH] doc: update --- README.md | 8 ++++---- README_zh.md | 8 ++++---- doc/quick_start_en.md | 2 +- doc/quick_start_zh.md | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6a4c5e0d..8ebc7b37 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,15 @@ frp is under development and you can try it with latest release version.Master b ## Quick Start -Read the [QuickStart](doc/quick_start_en.md) +Read the [QuickStart](/doc/quick_start_en.md) -[Tcp port forwarding](doc/quick_start_en.md#tcp-port-forwarding) +[Tcp port forwarding](/doc/quick_start_en.md#tcp-port-forwarding) -[Http port forwarding and Custom domain binding](doc/quick_start_en.md#http-port-forwarding-and-custom-domains-binding) +[Http port forwarding and Custom domain binding](/doc/quick_start_en.md#http-port-forwarding-and-custom-domains-binding) ## Architecture -![architecture](doc/pic/architecture.png) +![architecture](/doc/pic/architecture.png) ## Contributing diff --git a/README_zh.md b/README_zh.md index 45cea022..a3485480 100644 --- a/README_zh.md +++ b/README_zh.md @@ -21,15 +21,15 @@ frp 目前正在前期开发阶段,master分支用于发布稳定版本,dev ## 快速开始 -[使用文档](doc/quick_start_zh.md) +[使用文档](/doc/quick_start_zh.md) -[tcp 端口转发](doc/quick_start_zh.md#tcp-端口转发) +[tcp 端口转发](/doc/quick_start_zh.md#tcp-端口转发) -[http 端口转发,自定义域名绑定](doc/quick_start_zh.md#http-端口转发自定义域名绑定) +[http 端口转发,自定义域名绑定](/doc/quick_start_zh.md#http-端口转发自定义域名绑定) ## 架构 -![architecture](doc/pic/architecture.png) +![architecture](/doc/pic/architecture.png) ## 贡献代码 diff --git a/doc/quick_start_en.md b/doc/quick_start_en.md index 4e4c7675..162ca182 100644 --- a/doc/quick_start_en.md +++ b/doc/quick_start_en.md @@ -79,7 +79,7 @@ use_encryption = true ## Http port forwarding and Custom domains binding -If you only want to forward port one by one, you just need refer to [Tcp port forwarding](doc/quick_start_en.md#Tcp-port-forwarding).If you want to visit different web pages deployed in different web servers by **server B**'s **80 port**, you should specify the type as **http**. +If you only want to forward port one by one, you just need refer to [Tcp port forwarding](/doc/quick_start_en.md#Tcp-port-forwarding).If you want to visit different web pages deployed in different web servers by **server B**'s **80 port**, you should specify the type as **http**. You also need to resolve your **A record** of your custom domain to [server_addr], or resolve your **CNAME record** to [server_addr] if [server_addr] is a domain. diff --git a/doc/quick_start_zh.md b/doc/quick_start_zh.md index 3208bdae..d26538d9 100644 --- a/doc/quick_start_zh.md +++ b/doc/quick_start_zh.md @@ -79,7 +79,7 @@ use_encryption = true ## http 端口转发,自定义域名绑定 -如果只需要一对一的转发,例如**服务器B**的**80端口**转发**服务器A**的**8000端口**,则只需要配置 [tcp 端口转发](doc/quick_start_zh.md#tcp-端口转发) 即可,如果需要使**服务器B**的**80端口**可以转发至**多个**web服务端口,则需要指定代理的类型为 http,并且在 frps 的配置文件中配置用于提供 http 转发服务的端口。 +如果只需要一对一的转发,例如**服务器B**的**80端口**转发**服务器A**的**8000端口**,则只需要配置 [tcp 端口转发](/doc/quick_start_zh.md#tcp-端口转发) 即可,如果需要使**服务器B**的**80端口**可以转发至**多个**web服务端口,则需要指定代理的类型为 http,并且在 frps 的配置文件中配置用于提供 http 转发服务的端口。 按照如下的内容修改配置文件后,需要将自定义域名的 **A 记录**解析到 [server_addr],如果 [server_addr] 是域名也可以将自定义域名的 **CNAME 记录**解析到 [server_addr]。