Merge pull request #15 from yg3630536/feature/add-doc-for-build-tool-web

Feature/add doc for build tool web
WeBankBlockchain · Jun 2, 2020 · 89d745c · 89d745c
2 parents ea7157d + e6b0cc0
commit 89d745c
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 3 deletions.
diff --git a/readthedocs/zh_CN/docs/weidentity-build-with-deploy.rst b/readthedocs/zh_CN/docs/weidentity-build-with-deploy.rst
@@ -96,7 +96,7 @@ WeIdentity JAVA SDK 安装部署工具（部署智能合约）
 
     cd resources/
 
-FISCO BCOS 2.0请参考\ `2.0 web3sdk客户端配置 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/sdk.html#sdk>`__\，将证书文件 ``ca.crt``， ``node.crt`` 和 ``node.key`` 复制出来，拷贝至当前目录下。
+FISCO BCOS 2.0请参考\ `2.0 web3sdk客户端配置 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/java_sdk.html#sdk>`__\，将证书文件 ``ca.crt``， ``node.crt`` 和 ``node.key`` 复制出来，拷贝至当前目录下。
 
 1.3 部署智能合约并自动生成配置文件
 '''''''''''''''''''''''''''''''''''

diff --git a/readthedocs/zh_CN/docs/weidentity-build-without-deploy.rst b/readthedocs/zh_CN/docs/weidentity-build-without-deploy.rst
@@ -100,7 +100,7 @@ WeIdentity JAVA SDK 安装部署工具（不部署智能合约）
 
     cd resources/
 
-FISCO BCOS 2.0请参考\ `2.0 web3sdk客户端配置 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/java_sdk.html>`__\ 将证书文件 ``ca.crt``， ``node.crt`` 和 ``node.key`` 复制出来，拷贝至当前目录下。
+FISCO BCOS 2.0请参考\ `2.0 web3sdk客户端配置 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/java_sdk.html#sdk>`__\ 将证书文件 ``ca.crt``， ``node.crt`` 和 ``node.key`` 复制出来，拷贝至当前目录下。
 
 
 1.3 部署智能合约并自动生成配置文件

diff --git a/readthedocs/zh_CN/docs/weidentity-installation-by-web.rst b/readthedocs/zh_CN/docs/weidentity-installation-by-web.rst
@@ -19,7 +19,7 @@ WeIdentity JAVA SDK安装部署文档（可视化版本）
 """"""""""
 .. code-block:: shell
 
-  wget -c  https://github.com/WeBankFinTech/weid-build-tools/raw/develop/script/install_build_tool.sh
+  wget -c  https://github.com/WeBankFinTech/weid-build-tools/raw/master/script/install_build_tool.sh
 
 2.执行安装脚本
 """"""""""
@@ -28,6 +28,7 @@ WeIdentity JAVA SDK安装部署文档（可视化版本）
 
   chmod u+x install_build_tool.sh
   ./install_build_tool.sh
+  cd weid-build-tools
 
 3.执行构建脚本
 """"""""""
@@ -53,6 +54,54 @@ WeIdentity JAVA SDK安装部署文档（可视化版本）
 .. note::
      如果您想使用命令版本, 可以按照 `命令版本部署 - 1.2章节 <./weidentity-build-with-deploy.html>`_ 来操作。
 
+操作说明
+--------
+
+通过内网ip访问http://ip:6102/index.html将开启可视化操作之旅。
+
+1. 配置admin账户
+""""""""""
+
+此步骤将配置您在 weid-build-tools 里面的账户，后续的部署等操作将使用该秘钥，请妥善保管，谨防丢失。
+
+2. 配置区块链节点
+""""""""""
+
+此步骤将配置连接的区块链节点，您需要提前部署区块链节点。
+
+.. note::
+     1. 请选择合适的部署环境，联盟链成员的环境需要一致。
+     2. 配置区块链节点端口时请使用channel端口。
+     3. 配置chainId时，联盟链成员的chainId需要一致
+     4. 配置主群组时，联盟链成员的主群组Id需要一致
+
+3. 配置数据库
+""""""""""
+
+此步骤将配置连接的数据库环境，请提前准备数据库名称。
+
+4. 主群组部署合约
+""""""""""
+
+完成以上3步操作即完成了 weid-build-tools 的基础配置工作，此步骤将区分联盟链管理员和非管理员进行操作。
+
+* 联盟链管理员
+
+如果您是联盟链管理员，请点击页面的合约部署功能按钮，此步骤将在联盟链的当前主群组中部署您的WeID智能合约, 并且将会自动启用该合约的CNS地址。
+
+
+* 非管理员
+
+如果您不是联盟链管理员，请先联系联盟链管理员部署WeId智能合约，联盟链管理员部署完WeId智能合约后，请刷新当前页面并确认智能合约的CNS地址，请启用该CNS地址。
+
+.. note::
+     当您启用完CNS地址后，weid-build-tools 将自动帮您在第一步配置的账户注册成WeID, 如果有需要请将WeId地址发给联盟链管理员进行权威机构注册，可以通过WeId管理菜单查看您的WeId地址。
+
+5. 部署Evidence合约
+""""""""""
+
+此步骤可根据群组Id部署Evidence合约，如果您的机构不需要部署Evidence合约，只需要启用群组管理员部署的Evidence合约，请跟当前群组Id的管理员机构确认CNS编码，确认后再点击启用即可。
+
 
 附
 """"""""""""""""""""""""""""""""