Merge pull request #25 from merlanx/xml

[20200729] Revised deploy-via-web.rst as per Weidentity Web Tool changes

readthedocs/zh_CN/docs/deploy-via-web.rst

@@ -4,80 +4,115 @@
 .. _deploy-via-web:
 
 使用 WeIdentity 部署工具完成部署（可视化部署方式）
-=================================================
-
-步骤说明
---------
-
+=====================================================================
 
 0. 打开 WeIdentity 部署工具的 Web 页面
-""""""""""""""""""""""""""""""""""""""""""""""
+""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
-* 通过安装 “WeIdentity 部署工具”的服务器的 IP 访问 Web 页面 :code:`http://ip:6102/index.html` 。
+通过安装 “ WeIdentity 部署工具” 的服务器的公网 IP 访问 Web 页面 :code:`http://ip:6102/guide.html` 以进行 WeIdentity JAVA SDK 的部署。
 
 .. note::
-     如果还没有安装 WeIdentity 部署工具，请参考： \ `安装 WeIdentity 部署工具 <./weidentity-installation.html>`_\ 
+     1. 在使用之前, 请确保已安装 WeIdentity 部署工具, 详见文档：\ `安装 WeIdentity 部署工具 <./weidentity-installation.html>`_\
+     2. 若无法使用 Web 页面, 请使用命令行的方式完成部署, 详见文档：\ `部署文档(命令行部署方式) <./deploy-via-commandline.html>`_\。
+     3. 在部署之前, 请确保已安装 FISCO-BCOS 区块链, 详见文档：`「FISCO-BCOS 2.x 节点安装方法」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/installation.html>`_\
 
-.. note::
-     如果不方便通过网页完成部署，可以使用命令行的方式完成部署，详见文档：\ `部署文档(命令行部署方式) <./deploy-via-commandline.html>`_\。
+1. 选择角色
+"""""""""""""""""""""""""""
 
+此步骤可选择部署时所用的角色, 包括 “联盟链委员会管理员” 和 “非联盟链委员会管理员”, 如下图所示。
 
-1. 配置admin账户
-"""""""""""""""""
+   .. image:: images/deploy-via-web-guide-choose-role.png
+      :alt: deploy-via-web-guide-choose-role.png
 
-此步骤将配置您在 weid-build-tools 里面的账户，后续的部署等操作将使用该账户（请妥善保管私钥，谨防丢失）。
+.. note::
+     什么是“联盟链委员会管理员”?
+       一条联盟链中, 选取一家机构来作为联盟链管理员, 一般为创世节点所在机构, 此机构将作为联盟链委员会管理员来管理此链中使用的WeID相关合约。
 
 2. 配置区块链节点
-"""""""""""""""""
+"""""""""""""""""""""""""""
 
-此步骤将配置连接的区块链节点，您需要提前部署区块链节点。
+此步骤将配置需连接的区块链节点(:download:`点击下载配置示例 <./samples/run.config.sample>`), 如下图所示。
 
-.. note::
-     1. 请选择合适的部署环境，联盟链成员的环境需要一致。
-     2. 配置区块链节点端口时请使用channel端口。
-     3. 配置chainId时，联盟链成员的chainId需要一致
-     4. 配置主群组时，联盟链成员的主群组Id需要一致
+   .. image:: images/deploy-via-web-guide-setup-blockchain.png
+      :alt: deploy-via-web-guide-setup-blockchain.png
 
-3. 配置数据库
-"""""""""""""""""
+   - 配置机构名称
+      * 配置说明：机构名称用于标识机构唯一性, 可作为链上存储时的唯一标识, 亦可用作机构间的 AMOP 通信标识, 还可作为联盟链成员的IssuerName。
+      * 配置要求：建议使用机构的英文名称或简称, 并确保机构名称在联盟链成员中唯一。
 
-此步骤将配置连接的数据库环境，请提前准备数据库名称。
+   - 配置 AMOP 通讯 ID
+      * 配置说明：此 ID 将作为节点间 AMOP 通讯所需要的Topic来进行监听。AMOP 通讯可在不同机构的节点间通讯, 亦可在同一机构内的不同节点间通讯。
+      * 配置要求：建议使用英文, 并确保 ID 机构唯一或 VPC 唯一。
 
-4. 主群组部署合约
-""""""""""""""""""
+   - 配置部署环境
+      * 配置说明：目前支持三种部署环境, 生产环境, 测试环境和开发环境。不同环境可使用同一条区块链, 亦可各自使用独立的链。
+      * 配置要求：请根据实际需要选择, 并确保联盟链成员的环境一致。
 
-完成以上3步操作即完成了 weid-build-tools 的基础配置工作，此步骤将区分联盟链管理员和非管理员进行操作。
+   - 配置区块链节点 IP 和 Channel 端口
+      * 配置说明：区块链节点 IP 为 WeIdentity 所需使用的区块链节点的内网或公网 IP。Channel 端口用于 WeIdentity 部署工具, WeIdentity SDK 与区块链节点间的通信。
+      * 配置要求：格式为区块链节点 IP:Channel 端口。如需使用多个区块链节点, 请用半角逗号","分隔。默认端口号为20200。
+      * 配置示例：10.10.4.1:20200,10.10.4.2:20200,127.0.0.1:20200
 
-* 联盟链管理员
+   - 配置 sdk 证书
+      * 配置说明：通过web3sdk连接机构节点时需要使用 sdk 证书。
+      * 配置要求：登录区块链节点服务器, 生成/拷贝证书文件, 并下载到本机后上传。sdk 证书文件包括 ca.crt, node.crt 和 node.key。
 
-如果您是联盟链管理员，请点击页面的合约部署功能按钮，此步骤将在联盟链的当前主群组中部署您的WeID智能合约, 并且将会自动启用该合约的CNS地址。
+.. note::
+     1. \ `「什么是 AMOP ?」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/amop_protocol.html?highlight=amop>`_\
+     2. \ `「什么是 Channel 端口?」 <https://mp.weixin.qq.com/s/XZ0pXEELaj8kXHo32UFprg>`_\
+     3. \ `「如何获得 sdk 证书?」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/enterprise_tools/operation.html#get-sdk-file>`_\
+     4. \ `「区块链中的各种证书」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/certificates.html>`_\
+
+3. 选择主群组 ID
+"""""""""""""""""""""""""""
 
+此步骤可选择所需使用的主群组, 如下图所示。
 
-* 联盟链的普通成员
+   .. image:: images/deploy-via-web-guide-choose-group-id.png
+      :alt: deploy-via-web-guide-choose-group-id.png
 
-如果您不是联盟链管理员，请先联系联盟链管理员部署WeId智能合约，联盟链管理员部署完WeId智能合约后，请刷新当前页面并确认智能合约的CNS地址，请启用该CNS地址。
+   - 选择主群组 ID
+      * 配置说明：主群组编号为联盟链成员节点所共有的群组编号, 此群组编号为区块链搭建的时候联盟链成员协调出来的群组编号。
+      * 配置要求：默认主群组 ID 为 1。请确保联盟链成员选择使用一致的主群组。
 
 .. note::
-     当您启用完CNS地址后，weid-build-tools 将自动帮您在第一步配置的账户注册成WeID, 如果有需要请将WeId地址发给联盟链管理员进行权威机构注册，可以通过WeId管理菜单查看您的WeId地址。
+   \ `「如何查看群组?」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/console.html#getgrouplist>`_\
+
+4. 配置数据库(可选)
+"""""""""""""""""""""""""""
 
-5. 部署Evidence合约
-""""""""""""""""""""
+此步骤将配置所需连接的数据库环境, 请提前安装数据库并创建数据库实例及用户, 如下图所示。
 
-此步骤可根据群组Id部署Evidence合约，如果您的机构不需要部署Evidence合约，只需要启用群组管理员部署的Evidence合约，请跟当前群组Id的管理员机构确认CNS编码，确认后再点击启用即可。
+   - 配置数据库
+      * 配置说明：目前支持MySql 5.7+ 数据库。当使用 Transportation, Envidence 异步存证, Persistence 数据存储等相关功能组件时, 必需使用数据库。
+      * 配置示例: :download:`点击下载配置示例 <./samples/run.config.sample>`
 
+   .. image:: images/deploy-via-web-guide-setup-database.png
+      :alt: deploy-via-web-guide-setup-database.png
 
-附
-""""""""""""""""""""""""""""""""
+5. 创建管理员 WeID (仅限联盟链委员会管理员)
+""""""""""""""""""""""""""""""""""""""""""
 
-1. 请访问主页通过指引来完成配置和部署合约等相关操作。
+此步骤将配置您在 weid-build-tools 里面的 Admin 账户, 后续的部署等操作将使用该账户（请妥善保管私钥, 谨防丢失）。
 
-* 需要提前准备区块链节点
+   .. image:: images/deploy-via-web-guide-create-admin-weid.png
+      :alt: deploy-via-web-guide-create-admin-weid.png
 
-* 需要有可访问的MySql数据库
+6. 部署 WeIdentity 智能合约(仅限联盟链委员会管理员)
+"""""""""""""""""""""""""""""""""""""""""""""""""
 
+此步骤将部署 WeIdentity 智能合约 到指定的区块链上, 如图所示。
 
-2. 合约部署完成将会生成相关的配置文件:
+   .. image:: images/deploy-via-web-guide-deploy-weid-contract.png
+      :alt: deploy-via-web-guide-deploy-weid-contract.png
 
-* admin密钥文件目录 : ./output/admin/
+   - 选择链 ID (Chain Id)
+         * 配置说明：待连接节点所属的链ID, 安装区块链时自动生成, 一般情况下无需更改。
+         * 配置要求: 默认 Chain Id 为 1。
+
+.. note::
+   1. \ `「什么是链 ID (Chain Id) ?」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/go_sdk/env_conf.html?highlight=%E9%93%BEid#id6>`_\
+   2. WeIdentity 智能合约部署完成后将会在 `./output/admin/` 目录下生成 Admin 密钥文件, 用于后续注册权威机构等操作, 请妥善保管。
+   3. WeIdentity 智能合约部署完成后将会在 `./resources/` 目录下生成相关文件, 以便于您的应用集成 WeIdentity JAVA SDK。
 
-* 资源文件目录(用于应用集成SDK): ./resources/
+至此, WeIdentity JAVA SDK 的部署已完成。您可以继续通过 WeIdentity 部署工具体验使用 WeIdentity JAVA SDK 的功能, 详见文档。

readthedocs/zh_CN/docs/samples/run.config.sample

@@ -0,0 +1,38 @@
+#config your enviroment 
+
+#Note:Once you modify any of these configuration items, you need to re-run ./compile.sh.
+
+#fill with your node ip and channel_listen_port, example: 0.0.0.0:20200
+#if you have more than one node ,you can put them with separator","
+#for example: 0.0.0.0:20200,0:0:0:1:20200 
+blockchain_address=127.0.0.1:20200
+
+#this build tool supports FISCO BCOS 1.3.x and FISCO BCOS 2.0
+#if you want to build on FISCO BCOS 1.3.X, please fill with "1",
+#if you want to build on FISCO BCOS 2.0, please fill with "2".
+#and default value is "2" with FISCO BCOS 2.0.
+blockchain_fiscobcos_version=2
+
+#your organization name, used for communication on blockchain.
+org_id=weid
+
+#amop_id
+amop_id=weid
+
+#chain id
+chain_id=1
+
+#group id
+group_id=1
+
+#Configure your database information
+mysql_address=127.0.0.1:3306
+mysql_database=weid
+mysql_username=weid
+mysql_password=weid@123
+
+#This variable is used to distinguish the environment. You can use "dev" to set the development environment, 
+#"stg" to set the test environment, "prd" to set the production environment.
+#If you do not set it, the system will use allOrg as the environment by default. 
+#It is not recommended. Production use default configuration
+cns_profile_active=prd

readthedocs/zh_CN/docs/weidentity-installation.rst

@@ -27,7 +27,7 @@
    * - JDK
      - 要求\ `JDK1.8+ <https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html>`_\ ，推荐使用jdk8u141。JDK 跟 WeID 直接的兼容性，可见\ `兼容性文档 <https://weidentity.readthedocs.io/zh_CN/latest/docs/weid-compatibility-test.html>`_\
    * - 网络连通
-     - 检查部署 WeIdentity JAVA SDK 的服务器是否能 telnet 通 FISCO BCOS 节点的 channel 端口（\ `channel端口是什么，详见 <https://https://mp.weixin.qq.com/s/XZ0pXEELaj8kXHo32UFprg>`_\），若telnet不通，需要检查网络连通性和安全策略。
+     - 检查部署 WeIdentity JAVA SDK 的服务器是否能 telnet 通 FISCO BCOS 节点的 channel 端口（\ `channel端口是什么，详见 <https://mp.weixin.qq.com/s/XZ0pXEELaj8kXHo32UFprg>`_\），若telnet不通，需要检查网络连通性和安全策略。
 
 
 安装 WeIdentity 部署工具