Merge pull request #5 from jamesfancy/master

translate rewrite parts and faqs

Author: zdying

source/faqs/index.md

@@ -1,39 +1,39 @@
 title: FAQs
 ---
 
-### hiproxy的核心目的／功能是什么？
+### What's the core feature(or purpose) of hiproxy?
 
-hiproxy的核心功能是代理请求，主要是为了解决前端开发工程师在本地开发过程中遇到的：
+The core feature of hiproxy is forwarding request. Hiproxy purposes to solve some problems which front-end developer can meet while working:
 
-- `hosts`修改后由于DNS缓存不能立刻生效
-- 需要使用Nginx来做反向代理
-- 自签名HTTPS证书不受信任
-- 每个人都在本地维护环境配置文件（hosts／Nginx配置）
+- `hosts` cannot work immediately since there are caches after it's updated.
+- Nginx is used for reverse proxy.
+- Self signed HTTPS certificate are not trusted.
+- Everyone maintans the environment profile (hosts/nginx configuration).
 - ...
 
 <br/>
 
-### hiproxy跟Charles／Fiddler有什么区别？
+### What's the difference between hiproxy and Charles／Fiddler?
 
-hiproxy跟Charles/Fiddler都有抓包、请求代理的功能，很多核心的功能基本类似。只不过hiproxy是一个命令行的工具，使用配置文件来配置。
+They all have the ability to capture packages, proxy request and many core function. But hiproxy is a CLI tool which works with configuration files.
 
-此外，hiproxy现在没有查看网络请求的具体内容的界面，将来会通过插件开发，敬请期待。
+However, hiproxy has no interface to see the specific content of request. That will be introduced as a plugin in the future.
 
 <br/>
 
-### hiproxy的hosts跟系统hosts有什么关系？
+### What's the relationship between hosts for hiproxy and for OS？
 
-hiproxy的hosts跟系统hosts文件本身没有任何关系。
+They are no relationship actually.
 
-hiproxy的hosts文件一般存放在项目中，或者其他目录（根据用户情况自己决定放到哪里）。hiproxy代理服务启动的时候，会查找并解析这些hosts文件，**不会去查找解析系统hosts**。
+the hosts file for hiproxy is normally placed in project directory, or other (user specified) directory. Hiproxy would looking for, load and parse the hosts file in project directories, **but not do with OS one**.
 
 <br/>
 
-### hiproxy的rewrite配置文件完全兼容Nginx配置吗？
+### Is the rewrite configuration file for hiproxy fully compatible with Nginx configuration?
 
-不兼容，hiproxy的rewrite规则配置文件跟Nginx的配置文件本身没有任何关系。
+No. They are no relationship actually.
 
-从语法上看，hiproxy的rewrite配置文件借鉴了Nginx配置的语法。核心的语法跟Nginx的语法一致，但是也有些语法是hiproxy特有的，并不完全跟Nginx语法一致，比如：
+The rewrite configuration for rewrite has similar syntax of Nginx configuration. The core syntax is consistent with the syntax of Nginx, but there are also some syntax are specific to hiproxy. They are not exactly consistent with Nginx syntax. For example:
 
 ```bash
 # base rule
@@ -45,36 +45,35 @@ hiproxy.org => {
 }
 ```
 
-此外，也有部分指令采用Nginx的指令名称且功能基本类似，比如`proxy_pass`、`set`、`ssl_certificate`和`ssl_certificate_key`等。但是也**不保证所有的功能细节跟Nginx的指令保持一致**。详细的指令功能说明请参考[指令](../rewrite/directive.html)。
+In addition, some directives come from Nginx which do simular things, such as `proxy_pass`, `set`, `ssl_certificate` and `ssl_certificate_key`, etc. In any case they **cannot promise that all details are same as Nginx directives.**Please see [Directive](../rewrite/directive.html) for more information.
 
 <br/>
 
-### hiproxy多个项目中的不同配置文件使用相同的域名吗？
+### Are different configuration file used in multiple hiproxy projects using the same domain name?
 
-支持。
+It's supported.
 
-可以在不同的项目的不同配置文件中，给相同的域名配置代理规则。hiproxy会自动合并相同域名的规则，如果路由配置有冲突，后加载的配置文件的规则会覆盖前面的规则。
+You can set rules for the same domain name in configuration files of different projects. Hiproxy can merge all rules about the same domains. If there is conflict, later loaded rules would rewrite earlier rules.
 
 <br/>
 
-### hiproxy怎么处理多个配置文件中的规则冲突？
-
-详细的配置规则处理文档正在编写。
+### How does hiproxy handle the conflict between multiple configuraton files?
 
+Some soon.
 
 <br/>
 
-### hiproxy根证书怎么获取／导入？
+### How to get/import root certificate of hiproxy？
 
-可以查看文档[获取／导入SSL证书](../configuration/ssl_certificate.html)。
+See [get／import SSL certificate](../configuration/ssl_certificate.html)。
 
 <br/>
 
-### hiproxy中如何使用自己的SSL证书？
+### How hiproxy to use it own SSL certificate？
 
-默认情况下，在代理https请求的时候，hiproxy会**自动生成证书**，并使用hiproxy自定义的CA证书签名。用户只需要导入hiproxy的根证书。
+By default, when the https request is forwading, hiproxy will **generate the certifiate automatically** and use customized CA certificate signature. The users should import root certificate of hiproxy.
 
-如果用户需要使用自定义的证书，可以·使用hiproxy提供的指令来配置：
+If you use customized certificate, ou can use some hiproxy directive for configurating:
 
 ```
 ssl_certificate     ./hiproxy.org.crt;

source/rewrite/built_in_variable.md

@@ -1,72 +1,87 @@
-title: Rewrite built in variables
+title: Rewrite Built-in Variables
 ---
 
-> 如果你愿意帮助hiproxy编写文档，请联系zdying@live.com, 谢谢！
->
 > If you are willing to help hiproxy to write documentation, please contact zdying@live.com, thank you!
 
-hiproxy的rewrite规则配置文件中，我们可以自己定义全局变量（在全局作用域中使用`set $var value`），也可以在其他作用域中定义变量；
+You can define your own global variables (use `set $var value` in global scope) in rewrite rules configuration file of hiproxy, as well as you can define variables in other scopes.
 
-hiproxy内置了一些变量，这些内置变量可以在相应的作用域中直接使用，不需要去定义并赋值，而且这些内置变量也不能被用户重新定义覆盖。
+Hiproxy has some built-in variables so that you can use them directly in corresponding scopes without neither defining nor assigning. Particularly, user cannot redefine the variables to overwrite them.
 
-## 全局变量
+## Global variables
 
-这些全局变量，在配置文件的**任何地方都可以使用**。
+Global variables can **be used in everywhere of configuration files**.
 
-> 提示：hiproxy暂时没有内置的全局变量。将来会添加！
+> Hint: hiproxy currently has not built-in variables. Some would be added in the furture.
 
-## location块级变量
+## Location block scope variables
 
-这些变量，只能在`location`块中使用，这些变量主要是存储与请求相关的一些信息，比如请求的参数（`$query_string`）、Cookie（`$cookie_name`）和host（`$host`)等。现在支持的所有内置变量：
+You can use the variables only in `location` blocks. Then are used to store information about request, such as query string(`$query_string`), Cookie(`$cookie_name`), and host(`$host`), etc. Here are all the variables that are currently supported:
 
 ### $host
-当前请求的URL对应的`host`或者请求头部的`Host`字段。
+
+The `host` correlative to the current request URL, or the `Host` field in request headers.
 
 ### $hostname
-当前请求的URL对应的`hostname`或者请求头部的`Host`字段对应的`hostname`。
+
+The `hostname` correlative to the current request URL, or correlative to the `Host` field in request headers.
 
 ### $server_port
-请求的服务端口号，默认`80`。
+
+The server port number of the request, default `80`.
 
 ### $search
-请求的参数字符串（包括`?`），比如`?from=app&v=19482848253`。
+
+The query string (with `?`) of the request, such as `?from=app&v=19482848253`.
 
 ### $query_string
-请求的参数字符串（**不包括`?`**），比如`from=app&v=19482848253`。
+
+The query string (**without `?`**), such as `from=app&v=19482848253`.
 
 ### $scheme
-请求的协议，`http`或者`https`。
+
+The request protocol, it's either `http` or `https`.
 
 ### $request_uri
-请求的完整地址，比如`http://hiproxy.org:8081/docs/index.html?from=google&v=_1847295727524#get-started`。
+
+The entire request URL, such as `http://hiproxy.org:8081/docs/index.html?from=google&v=_1847295727524#get-started`.
 
 ### $path
-请求的`path`（包括参数），比如`/docs/index.html?from=google&v=_1847295727524#get-started`。
+
+The request `path` (with query string), such as `/docs/index.html?from=google&v=_1847295727524#get-started`.
 
 ### $path_name
-请求的`path_name`（不包括参数），比如`/docs/index.html`。
+
+The request `path_name` (without query string), such as `/docs/index.html`.
 
 ### $base_name
-请求path的最后一部分，比如path为`/docs/index.html`，则$base_name为`index.html`。
+
+The last part of the path. For exampke, let's say the path is `/docs/index.html`, so that $base_name is `index.html`.
 
 ### $dir_name
-请求path的目录名称，比如path为`/docs/index.html`，则$dir_name为`/docs/`。
+
+The directory names of the path. For example, let's say path is `/docs/index.html`, so that $dir_name is `/docs/`.
 
 ### $hash
-请求url中的`hash`(包括`#`)，比如'#get-started'。
+
+The `hash` (with `#`) of request URL, such as `#get-started`.
 
 ### $hash_value
-请求url中的`hash`值(不包括`#`)，比如'get-started'。
+
+The `hash` value (without `#`) of request URL, such as `get-started`.
 
 ### $uri
-同`$request_uri`。
+
+Same as `$request_uri`.
 
 ### $cookie_*name*
-`cookie`的值，`name`表示字段名称，这个名称中的大写字母都改成了小写，`-`替换成了`_`。比如`$cookie_userId`表示`cookie`中`useId`的值。
+
+A `cookie` value. The `name` stands field name whose capital letters have been changed to lower ones and `-` characters have been changed to `_`. For example, `$cookie_userId` is for the value of `userId` in the `cookie`.
 
 ### $http_*name*
-请求头（request）中的字段值，`name`表示字段名称，这个名称中的大写字母都改成了小写，`-`替换成了`_`。比如请求头信息中包含`User-Agent: user agent`，可以使用变量`$http_user_agent`来获取这个值。
+
+The value of a request header field. The `name` stands field name whose capital letters have been changed to lower ones and `-` characters have been changed to `_`. For example, let's say `User-Agent: user agent` is a valid request header, then `$http_user_agent` can get its value.
 
 ### $arg_*name*
-请求参数的值，`name`表示字段名称，这个名称中的大写字母都改成了小写，`-`替换成了`_`。比如请求参数为`?from=google&v=_1847295727524`，可以通过`$arg_from`来获取`from`的值。
+
+The value of a request query parameter. The `name` stands field name whose capital letters have been changed to lower ones and `-` characters have been changed to `_`. For example, let's say the query string is ``?from=google&v=_1847295727524`, then `$arg_from` can get value of `from`.