Skip to content

Commit 01dba5f

Browse files
committed
add link to summary
also update doc:build script to build the site
1 parent d7e68ca commit 01dba5f

File tree

17 files changed

+223
-120
lines changed

17 files changed

+223
-120
lines changed

build_scripts/build-doc-site.sh

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/bin/bash
2+
3+
## get into the "build_scripts" folder regardless of the excution directory
4+
parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
5+
cd "$parent_path/.."
6+
7+
## compile the doc
8+
node ./build_scripts/prebuild-doc.js
9+
gitbook build ./docs-src ./docs
10+
11+
## push the doc into github
12+
git add ./docs
13+
git commit -m 'building docs'
14+
git push origin

docs-src/cn/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -810,6 +810,14 @@ module.exports = {
810810

811811
<img src="https://zos.alipayobjects.com/rmsportal/hVWkXHrzHmOKOtCKGUWx.png" width="500" />
812812

813+
### 安卓系统信任CA证书
814+
首先和iOS类似,需要先扫描证书的二维码进行下载。然后不同的安卓系统安装证书的方式可能有所不同,但是安装的步骤是类似的,我们列举了几种类型。
815+
816+
* 下载后的证书可以直接单击打开并安装,这种方式是最简单的,直接安装即可
817+
* 证书下载到指定目录后,需要从其他入口进行安装,包括:
818+
* 设置 -> 安全性与位置信息 -> 加密与凭据 -> 从存储设备安装。找到你下载的证书文件,进行安装
819+
* 设置 -> 安全 -> 从SD卡安装证书。找到你下载的证书文件,进行安装
820+
813821
### 配置iOS/Android系统代理
814822

815823
* 代理服务器都在wifi设置中配置

docs-src/cn/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,6 @@
3535
* [配置浏览器HTTP代理](README.md#配置浏览器http代理)
3636
* [iOS系统信任CA证书](README.md#ios系统信任ca证书)
3737
* [iOS >= 10.3信任CA证书](README.md#ios--103信任ca证书)
38+
* [安卓系统信任CA证书](README.md#安卓系统信任ca证书)
3839
* [配置iOS/Android系统代理](README.md#配置iosandroid系统代理)
3940
* [FAQ](README.md#faq)

docs-src/en/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -801,6 +801,15 @@ install :
801801

802802
* Besides installing root CA, you have to "turn on" the certificate for web manually in *settings - general - about - Certificate Trust Settings*. Otherwire, safari will not trust the root CA generated by AnyProxy.
803803

804+
### trust root CA in Android
805+
First of all, you need to download the root CA by clicking *Root CA* in web ui, and then scan the QR code.
806+
Installing CA in Android could be different based on the system, we list some common steps as below, but you can find the right way in you system with similar menu path.
807+
808+
* The downloaded CA file can be directly installed by clicking, this is the easist way
809+
* You need to install the CA file from other menu, such as:
810+
* Settings -> Security & Location > Encryption & credentials -> Install from storage, and find your CA file to install
811+
* Settings -> Security -> Install from SD card, and find you CA file to install
812+
804813
<img src="https://zos.alipayobjects.com/rmsportal/hVWkXHrzHmOKOtCKGUWx.png" width="500" />
805814

806815
### config iOS/Android proxy server

docs-src/en/SUMMARY.md

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,39 @@
11
# Summary
22

33
* [Introduction](README.md)
4-
* [Getting-Start](doc.md#getting-start)
5-
* [Install](doc.md#install)
6-
* [Launch](doc.md#launch)
7-
* [Options](doc.md#options)
8-
* [As Node Module](doc.md#use-anyproxy-as-an-npm-module)
9-
* [Proxy HTTPS](doc.md#proxy-https)
10-
* [Rule Introduction](doc.md#rule-introduction)
11-
* [Sample](doc.md#sample)
12-
* [How Does It Work](doc.md#how-does-it-work)
13-
* [Load A Rule](doc.md#how-to-load-rule-module)
14-
* [Rule Module Interfaces](doc.md#rule-module-interface)
15-
* [summary_class=rule-title](doc.md#summary)
16-
* [beforeSendRequest_class=rule-title](doc.md#beforesendrequest)
17-
* [beforeSendResponse_class=rule-title](doc.md#beforesendresponse)
18-
* [beforeDealHttpsRequest_class=rule-title](doc.md#beforedealhttpsrequest)
19-
* [onError_class=rule-title](doc.md#onerror)
20-
* [onConnectError_class=rule-title](doc.md#onconnecterror)
21-
* [Rule Samples](doc.md#rule-samples)
22-
* [Use local response_class=sample-title](doc.md#use-local-response)
23-
* [Modify Request Header_class=sample-title](doc.md#modify-request-header)
24-
* [Modify Request Body_class=sample-title](doc.md#modify-request-body)
25-
* [Modify The Request Target_class=sample-title](doc.md#modify-the-request-target)
26-
* [Modify Request Protocol_class=sample-title](doc.md#modify-request-protocol)
27-
* [Modify Response Status Code_class=sample-title](doc.md#modify-response-status-code)
28-
* [Modify The Response Header_class=sample-title](doc.md#modify-the-response-header)
29-
* [Modify Response Data And Delay_class=sample-title](doc.md#modify-response-data-and-delay)
30-
* [Config Certification](doc.md#config-certification)
31-
* [Config Root CA In OSX](doc.md#config-root-ca-in-osx)
32-
* [Configure Root CA In windows](doc.md#config-root-ca-in-windows)
33-
* [Config OSX System Proxy](doc.md#config-osx-system-proxy)
34-
* [Config As Http Proxy Server](doc.md#config-http-proxy-server)
35-
* [Trust Root CA In IOS](doc.md#trust-root-ca-in-ios)
36-
* [Trust Root CA In iOS after 10.3](doc.md#trust-root-ca-in-ios-after-103)
37-
* [Config IOS/Android Proxy Server](doc.md#config-iosandroid-proxy-server)
38-
* [FAQ](doc.md)
4+
* [Getting-Start](README.md#getting-start)
5+
* [Install](README.md#install)
6+
* [Launch](README.md#launch)
7+
* [Options](README.md#options)
8+
* [As Node Module](README.md#use-anyproxy-as-an-npm-module)
9+
* [Proxy HTTPS](README.md#proxy-https)
10+
* [Rule Introduction](README.md#rule-introduction)
11+
* [Sample](README.md#sample)
12+
* [How Does It Work](README.md#how-does-it-work)
13+
* [Load A Rule](README.md#how-to-load-rule-module)
14+
* [Rule Module Interfaces](README.md#rule-module-interface)
15+
* [summary_class=rule-title](README.md#summary)
16+
* [beforeSendRequest_class=rule-title](README.md#beforesendrequest)
17+
* [beforeSendResponse_class=rule-title](README.md#beforesendresponse)
18+
* [beforeDealHttpsRequest_class=rule-title](README.md#beforedealhttpsrequest)
19+
* [onError_class=rule-title](README.md#onerror)
20+
* [onConnectError_class=rule-title](README.md#onconnecterror)
21+
* [Rule Samples](README.md#rule-samples)
22+
* [Use local response_class=sample-title](README.md#use-local-response)
23+
* [Modify Request Header_class=sample-title](README.md#modify-request-header)
24+
* [Modify Request Body_class=sample-title](README.md#modify-request-body)
25+
* [Modify The Request Target_class=sample-title](README.md#modify-the-request-target)
26+
* [Modify Request Protocol_class=sample-title](README.md#modify-request-protocol)
27+
* [Modify Response Status Code_class=sample-title](README.md#modify-response-status-code)
28+
* [Modify The Response Header_class=sample-title](README.md#modify-the-response-header)
29+
* [Modify Response Data And Delay_class=sample-title](README.md#modify-response-data-and-delay)
30+
* [Config Certification](README.md#config-certification)
31+
* [Config Root CA In OSX](README.md#config-root-ca-in-osx)
32+
* [Configure Root CA In windows](README.md#config-root-ca-in-windows)
33+
* [Config OSX System Proxy](README.md#config-osx-system-proxy)
34+
* [Config As Http Proxy Server](README.md#config-http-proxy-server)
35+
* [Trust Root CA In IOS](README.md#trust-root-ca-in-ios)
36+
* [Trust Root CA In iOS after 10.3](README.md#trust-root-ca-in-ios-after-103)
37+
* [Trust Root CA In Android](README.md#trust-root-ca-in-android)
38+
* [Config IOS/Android Proxy Server](README.md#config-iosandroid-proxy-server)
39+
* [FAQ](README.md)

docs-src/en/_layouts/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
{% endfor %}
2020
{% endblock %}
2121
<link rel="shortcut icon" href="/assets/favicon.png" type="image/png">
22-
<link rel="stylesheet" href="/assets/styles/website.css">
22+
<link rel="stylesheet" href="/assets/website.css">
2323
<script src="/assets/main.js" ></script>
2424
</head>
2525
<body>

docs/cn/index.html

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<title>简介 · AnyProxy</title>
88
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
99
<meta name="description" content="">
10-
<meta name="generator" content="GitBook 3.2.2">
10+
<meta name="generator" content="GitBook 3.2.3">
1111
<meta name="author" content="AnyProxy">
1212

1313

@@ -649,6 +649,22 @@
649649

650650
<li class="chapter " data-level="1.7.7" data-path="./">
651651

652+
<a href="./#安卓系统信任ca证书">
653+
654+
655+
<div class="summary-title-span 安卓系统信任CA证书">
656+
安卓系统信任CA证书
657+
</div>
658+
659+
660+
</a>
661+
662+
663+
664+
</li>
665+
666+
<li class="chapter " data-level="1.7.8" data-path="./">
667+
652668
<a href="./#配置iosandroid系统代理">
653669

654670

@@ -1512,6 +1528,16 @@ <h3 id="ios--103&#x4FE1;&#x4EFB;ca&#x8BC1;&#x4E66;">iOS &gt;= 10.3&#x4FE1;&#x4EF
15121528
<li>&#x9664;&#x4E86;&#x4E0A;&#x8FF0;&#x8BC1;&#x4E66;&#x5B89;&#x88C5;&#x8FC7;&#x7A0B;&#xFF0C;&#x8FD8;&#x9700;&#x8981;&#x5728; <em>&#x8BBE;&#x7F6E;-&gt;&#x901A;&#x7528;-&gt;&#x5173;&#x4E8E;&#x672C;&#x673A;-&gt;&#x8BC1;&#x4E66;&#x4FE1;&#x4EFB;&#x8BBE;&#x7F6E;</em> &#x4E2D;&#x628A;AnyProxy&#x8BC1;&#x4E66;&#x7684;&#x5F00;&#x5173;&#x6253;&#x5F00;&#xFF0C;&#x5426;&#x5219;safari&#x5C06;&#x62A5;&#x9519;&#x3002;</li>
15131529
</ul>
15141530
<p><img src="https://zos.alipayobjects.com/rmsportal/hVWkXHrzHmOKOtCKGUWx.png" width="500"></p>
1531+
<h3 id="&#x5B89;&#x5353;&#x7CFB;&#x7EDF;&#x4FE1;&#x4EFB;ca&#x8BC1;&#x4E66;">&#x5B89;&#x5353;&#x7CFB;&#x7EDF;&#x4FE1;&#x4EFB;CA&#x8BC1;&#x4E66;</h3>
1532+
<p>&#x9996;&#x5148;&#x548C;iOS&#x7C7B;&#x4F3C;&#xFF0C;&#x9700;&#x8981;&#x5148;&#x626B;&#x63CF;&#x8BC1;&#x4E66;&#x7684;&#x4E8C;&#x7EF4;&#x7801;&#x8FDB;&#x884C;&#x4E0B;&#x8F7D;&#x3002;&#x7136;&#x540E;&#x4E0D;&#x540C;&#x7684;&#x5B89;&#x5353;&#x7CFB;&#x7EDF;&#x5B89;&#x88C5;&#x8BC1;&#x4E66;&#x7684;&#x65B9;&#x5F0F;&#x53EF;&#x80FD;&#x6709;&#x6240;&#x4E0D;&#x540C;&#xFF0C;&#x4F46;&#x662F;&#x5B89;&#x88C5;&#x7684;&#x6B65;&#x9AA4;&#x662F;&#x7C7B;&#x4F3C;&#x7684;&#xFF0C;&#x6211;&#x4EEC;&#x5217;&#x4E3E;&#x4E86;&#x51E0;&#x79CD;&#x7C7B;&#x578B;&#x3002;</p>
1533+
<ul>
1534+
<li>&#x4E0B;&#x8F7D;&#x540E;&#x7684;&#x8BC1;&#x4E66;&#x53EF;&#x4EE5;&#x76F4;&#x63A5;&#x5355;&#x51FB;&#x6253;&#x5F00;&#x5E76;&#x5B89;&#x88C5;&#xFF0C;&#x8FD9;&#x79CD;&#x65B9;&#x5F0F;&#x662F;&#x6700;&#x7B80;&#x5355;&#x7684;&#xFF0C;&#x76F4;&#x63A5;&#x5B89;&#x88C5;&#x5373;&#x53EF;</li>
1535+
<li>&#x8BC1;&#x4E66;&#x4E0B;&#x8F7D;&#x5230;&#x6307;&#x5B9A;&#x76EE;&#x5F55;&#x540E;&#xFF0C;&#x9700;&#x8981;&#x4ECE;&#x5176;&#x4ED6;&#x5165;&#x53E3;&#x8FDB;&#x884C;&#x5B89;&#x88C5;&#xFF0C;&#x5305;&#x62EC;&#xFF1A;<ul>
1536+
<li>&#x8BBE;&#x7F6E; -&gt; &#x5B89;&#x5168;&#x6027;&#x4E0E;&#x4F4D;&#x7F6E;&#x4FE1;&#x606F; -&gt; &#x52A0;&#x5BC6;&#x4E0E;&#x51ED;&#x636E; -&gt; &#x4ECE;&#x5B58;&#x50A8;&#x8BBE;&#x5907;&#x5B89;&#x88C5;&#x3002;&#x627E;&#x5230;&#x4F60;&#x4E0B;&#x8F7D;&#x7684;&#x8BC1;&#x4E66;&#x6587;&#x4EF6;&#xFF0C;&#x8FDB;&#x884C;&#x5B89;&#x88C5;</li>
1537+
<li>&#x8BBE;&#x7F6E; -&gt; &#x5B89;&#x5168; -&gt; &#x4ECE;SD&#x5361;&#x5B89;&#x88C5;&#x8BC1;&#x4E66;&#x3002;&#x627E;&#x5230;&#x4F60;&#x4E0B;&#x8F7D;&#x7684;&#x8BC1;&#x4E66;&#x6587;&#x4EF6;&#xFF0C;&#x8FDB;&#x884C;&#x5B89;&#x88C5;</li>
1538+
</ul>
1539+
</li>
1540+
</ul>
15151541
<h3 id="&#x914D;&#x7F6E;iosandroid&#x7CFB;&#x7EDF;&#x4EE3;&#x7406;">&#x914D;&#x7F6E;iOS/Android&#x7CFB;&#x7EDF;&#x4EE3;&#x7406;</h3>
15161542
<ul>
15171543
<li><p>&#x4EE3;&#x7406;&#x670D;&#x52A1;&#x5668;&#x90FD;&#x5728;wifi&#x8BBE;&#x7F6E;&#x4E2D;&#x914D;&#x7F6E;</p>
@@ -1609,7 +1635,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
16091635
<script>
16101636
var gitbook = gitbook || [];
16111637
gitbook.push(function() {
1612-
gitbook.page.hasChanged({"page":{"title":"简介","level":"1.1","depth":1,"next":{"title":"快速开始","level":"1.2","depth":1,"anchor":"#快速开始","path":"README.md","ref":"README.md#快速开始","articles":[{"title":"安装","level":"1.2.1","depth":2,"anchor":"#安装","path":"README.md","ref":"README.md#安装","articles":[]},{"title":"启动","level":"1.2.2","depth":2,"anchor":"#启动","path":"README.md","ref":"README.md#启动","articles":[]},{"title":"其他命令","level":"1.2.3","depth":2,"anchor":"#其他命令","path":"README.md","ref":"README.md#其他命令","articles":[]},{"title":"作为npm模块启动","level":"1.2.4","depth":2,"anchor":"#作为npm模块使用","path":"README.md","ref":"README.md#作为npm模块使用","articles":[]}]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"AnyProxy","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"AnyProxy","language":"cn","gitbook":"*","description":"A fully configurable http/https proxy in NodeJS"},"file":{"path":"README.md","mtime":"2017-12-04T09:09:48.736Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-12-04T09:09:50.456Z"},"basePath":".","book":{"language":"cn"}});
1638+
gitbook.page.hasChanged({"page":{"title":"简介","level":"1.1","depth":1,"next":{"title":"快速开始","level":"1.2","depth":1,"anchor":"#快速开始","path":"README.md","ref":"README.md#快速开始","articles":[{"title":"安装","level":"1.2.1","depth":2,"anchor":"#安装","path":"README.md","ref":"README.md#安装","articles":[]},{"title":"启动","level":"1.2.2","depth":2,"anchor":"#启动","path":"README.md","ref":"README.md#启动","articles":[]},{"title":"其他命令","level":"1.2.3","depth":2,"anchor":"#其他命令","path":"README.md","ref":"README.md#其他命令","articles":[]},{"title":"作为npm模块启动","level":"1.2.4","depth":2,"anchor":"#作为npm模块使用","path":"README.md","ref":"README.md#作为npm模块使用","articles":[]}]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"AnyProxy","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"AnyProxy","language":"cn","gitbook":"*","description":"A fully configurable http/https proxy in NodeJS"},"file":{"path":"README.md","mtime":"2018-01-03T15:10:19.584Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-01-03T15:10:20.722Z"},"basePath":".","book":{"language":"cn"}});
16131639
});
16141640
</script>
16151641
</div>

docs/cn/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/cn/src_doc.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -611,6 +611,14 @@ module.exports = {
611611

612612
<img src="https://zos.alipayobjects.com/rmsportal/hVWkXHrzHmOKOtCKGUWx.png" width="500" />
613613

614+
### 安卓系统信任CA证书
615+
首先和iOS类似,需要先扫描证书的二维码进行下载。然后不同的安卓系统安装证书的方式可能有所不同,但是安装的步骤是类似的,我们列举了几种类型。
616+
617+
* 下载后的证书可以直接单击打开并安装,这种方式是最简单的,直接安装即可
618+
* 证书下载到指定目录后,需要从其他入口进行安装,包括:
619+
* 设置 -> 安全性与位置信息 -> 加密与凭据 -> 从存储设备安装。找到你下载的证书文件,进行安装
620+
* 设置 -> 安全 -> 从SD卡安装证书。找到你下载的证书文件,进行安装
621+
614622
### 配置iOS/Android系统代理
615623

616624
* 代理服务器都在wifi设置中配置

0 commit comments

Comments
 (0)