From 01dba5fc92937a75e140dcbd385943c74e160850 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A0=9A=E7=84=B6?= Date: Sun, 7 Jan 2018 21:34:32 +0800 Subject: [PATCH] add link to summary also update doc:build script to build the site --- build_scripts/build-doc-site.sh | 14 +++ docs-src/cn/README.md | 8 ++ docs-src/cn/SUMMARY.md | 1 + docs-src/en/README.md | 9 ++ docs-src/en/SUMMARY.md | 71 ++++++------- docs-src/en/_layouts/layout.html | 2 +- docs/cn/index.html | 30 +++++- docs/cn/search_index.json | 2 +- docs/cn/src_doc.md | 8 ++ docs/en/index.html | 175 ++++++++++++++++++------------- docs/en/search_index.json | 2 +- docs/en/src_doc.md | 9 ++ docs/gitbook/gitbook.js | 4 +- docs/gitbook/theme.js | 2 +- docs/index.html | 2 +- docs/search_index.json | 2 +- package.json | 2 +- 17 files changed, 223 insertions(+), 120 deletions(-) create mode 100755 build_scripts/build-doc-site.sh diff --git a/build_scripts/build-doc-site.sh b/build_scripts/build-doc-site.sh new file mode 100755 index 0000000..a5e0153 --- /dev/null +++ b/build_scripts/build-doc-site.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +## get into the "build_scripts" folder regardless of the excution directory +parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P ) +cd "$parent_path/.." + +## compile the doc +node ./build_scripts/prebuild-doc.js +gitbook build ./docs-src ./docs + +## push the doc into github +git add ./docs +git commit -m 'building docs' +git push origin diff --git a/docs-src/cn/README.md b/docs-src/cn/README.md index aca96f6..0cf047a 100644 --- a/docs-src/cn/README.md +++ b/docs-src/cn/README.md @@ -810,6 +810,14 @@ module.exports = { +### 安卓系统信任CA证书 +首先和iOS类似，需要先扫描证书的二维码进行下载。然后不同的安卓系统安装证书的方式可能有所不同，但是安装的步骤是类似的，我们列举了几种类型。 + +* 下载后的证书可以直接单击打开并安装，这种方式是最简单的，直接安装即可 +* 证书下载到指定目录后，需要从其他入口进行安装，包括： + * 设置 -> 安全性与位置信息 -> 加密与凭据 -> 从存储设备安装。找到你下载的证书文件，进行安装 + * 设置 -> 安全 -> 从SD卡安装证书。找到你下载的证书文件，进行安装 + ### 配置iOS/Android系统代理 * 代理服务器都在wifi设置中配置 diff --git a/docs-src/cn/SUMMARY.md b/docs-src/cn/SUMMARY.md index e9fe3aa..437904f 100644 --- a/docs-src/cn/SUMMARY.md +++ b/docs-src/cn/SUMMARY.md @@ -35,5 +35,6 @@ * [配置浏览器HTTP代理](README.md#配置浏览器http代理) * [iOS系统信任CA证书](README.md#ios系统信任ca证书) * [iOS >= 10.3信任CA证书](README.md#ios--103信任ca证书) + * [安卓系统信任CA证书](README.md#安卓系统信任ca证书) * [配置iOS/Android系统代理](README.md#配置iosandroid系统代理) * [FAQ](README.md#faq) diff --git a/docs-src/en/README.md b/docs-src/en/README.md index 56ccc3b..300feda 100644 --- a/docs-src/en/README.md +++ b/docs-src/en/README.md @@ -801,6 +801,15 @@ install ： * 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. +### trust root CA in Android +First of all, you need to download the root CA by clicking *Root CA* in web ui, and then scan the QR code. +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. + +* The downloaded CA file can be directly installed by clicking, this is the easist way +* You need to install the CA file from other menu, such as: + * Settings -> Security & Location > Encryption & credentials -> Install from storage, and find your CA file to install + * Settings -> Security -> Install from SD card, and find you CA file to install + ### config iOS/Android proxy server diff --git a/docs-src/en/SUMMARY.md b/docs-src/en/SUMMARY.md index af787b5..5f2c9f2 100644 --- a/docs-src/en/SUMMARY.md +++ b/docs-src/en/SUMMARY.md @@ -1,38 +1,39 @@ # Summary * [Introduction](README.md) -* [Getting-Start](doc.md#getting-start) - * [Install](doc.md#install) - * [Launch](doc.md#launch) - * [Options](doc.md#options) - * [As Node Module](doc.md#use-anyproxy-as-an-npm-module) -* [Proxy HTTPS](doc.md#proxy-https) -* [Rule Introduction](doc.md#rule-introduction) - * [Sample](doc.md#sample) - * [How Does It Work](doc.md#how-does-it-work) - * [Load A Rule](doc.md#how-to-load-rule-module) -* [Rule Module Interfaces](doc.md#rule-module-interface) - * [summary_class=rule-title](doc.md#summary) - * [beforeSendRequest_class=rule-title](doc.md#beforesendrequest) - * [beforeSendResponse_class=rule-title](doc.md#beforesendresponse) - * [beforeDealHttpsRequest_class=rule-title](doc.md#beforedealhttpsrequest) - * [onError_class=rule-title](doc.md#onerror) - * [onConnectError_class=rule-title](doc.md#onconnecterror) -* [Rule Samples](doc.md#rule-samples) - * [Use local response_class=sample-title](doc.md#use-local-response) - * [Modify Request Header_class=sample-title](doc.md#modify-request-header) - * [Modify Request Body_class=sample-title](doc.md#modify-request-body) - * [Modify The Request Target_class=sample-title](doc.md#modify-the-request-target) - * [Modify Request Protocol_class=sample-title](doc.md#modify-request-protocol) - * [Modify Response Status Code_class=sample-title](doc.md#modify-response-status-code) - * [Modify The Response Header_class=sample-title](doc.md#modify-the-response-header) - * [Modify Response Data And Delay_class=sample-title](doc.md#modify-response-data-and-delay) -* [Config Certification](doc.md#config-certification) - * [Config Root CA In OSX](doc.md#config-root-ca-in-osx) - * [Configure Root CA In windows](doc.md#config-root-ca-in-windows) - * [Config OSX System Proxy](doc.md#config-osx-system-proxy) - * [Config As Http Proxy Server](doc.md#config-http-proxy-server) - * [Trust Root CA In IOS](doc.md#trust-root-ca-in-ios) - * [Trust Root CA In iOS after 10.3](doc.md#trust-root-ca-in-ios-after-103) - * [Config IOS/Android Proxy Server](doc.md#config-iosandroid-proxy-server) -* [FAQ](doc.md) +* [Getting-Start](README.md#getting-start) + * [Install](README.md#install) + * [Launch](README.md#launch) + * [Options](README.md#options) + * [As Node Module](README.md#use-anyproxy-as-an-npm-module) +* [Proxy HTTPS](README.md#proxy-https) +* [Rule Introduction](README.md#rule-introduction) + * [Sample](README.md#sample) + * [How Does It Work](README.md#how-does-it-work) + * [Load A Rule](README.md#how-to-load-rule-module) +* [Rule Module Interfaces](README.md#rule-module-interface) + * [summary_class=rule-title](README.md#summary) + * [beforeSendRequest_class=rule-title](README.md#beforesendrequest) + * [beforeSendResponse_class=rule-title](README.md#beforesendresponse) + * [beforeDealHttpsRequest_class=rule-title](README.md#beforedealhttpsrequest) + * [onError_class=rule-title](README.md#onerror) + * [onConnectError_class=rule-title](README.md#onconnecterror) +* [Rule Samples](README.md#rule-samples) + * [Use local response_class=sample-title](README.md#use-local-response) + * [Modify Request Header_class=sample-title](README.md#modify-request-header) + * [Modify Request Body_class=sample-title](README.md#modify-request-body) + * [Modify The Request Target_class=sample-title](README.md#modify-the-request-target) + * [Modify Request Protocol_class=sample-title](README.md#modify-request-protocol) + * [Modify Response Status Code_class=sample-title](README.md#modify-response-status-code) + * [Modify The Response Header_class=sample-title](README.md#modify-the-response-header) + * [Modify Response Data And Delay_class=sample-title](README.md#modify-response-data-and-delay) +* [Config Certification](README.md#config-certification) + * [Config Root CA In OSX](README.md#config-root-ca-in-osx) + * [Configure Root CA In windows](README.md#config-root-ca-in-windows) + * [Config OSX System Proxy](README.md#config-osx-system-proxy) + * [Config As Http Proxy Server](README.md#config-http-proxy-server) + * [Trust Root CA In IOS](README.md#trust-root-ca-in-ios) + * [Trust Root CA In iOS after 10.3](README.md#trust-root-ca-in-ios-after-103) + * [Trust Root CA In Android](README.md#trust-root-ca-in-android) + * [Config IOS/Android Proxy Server](README.md#config-iosandroid-proxy-server) +* [FAQ](README.md) diff --git a/docs-src/en/_layouts/layout.html b/docs-src/en/_layouts/layout.html index 0b56e83..41a2809 100644 --- a/docs-src/en/_layouts/layout.html +++ b/docs-src/en/_layouts/layout.html @@ -19,7 +19,7 @@ {% endfor %} {% endblock %} - + diff --git a/docs/cn/index.html b/docs/cn/index.html index 22af80a..dc2524a 100644 --- a/docs/cn/index.html +++ b/docs/cn/index.html @@ -7,7 +7,7 @@ 简介 · AnyProxy - + @@ -649,6 +649,22 @@
  • + + + +
    + 安卓系统信任CA证书 +
    + + +     + + + +
    • + +
  • + @@ -1512,6 +1528,16 @@ newResponse.body += '--from anyproxy--'除了上述证书安装过程，还需要在 设置->通用->关于本机->证书信任设置 中把AnyProxy证书的开关打开，否则safari将报错。

    • +

    安卓系统信任CA证书

    +

    首先和iOS类似，需要先扫描证书的二维码进行下载。然后不同的安卓系统安装证书的方式可能有所不同，但是安装的步骤是类似的，我们列举了几种类型。

    +

    配置iOS/Android系统代理