* update spec

* update deployment instruction
WeBankBlockchain · Jul 30, 2020 · 1fa25f8 · 1fa25f8
1 parent 8e23447
commit 1fa25f8
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 37 deletions.
diff --git a/readthedocs/zh_CN/docs/deploy-via-web.rst b/readthedocs/zh_CN/docs/deploy-via-web.rst
@@ -6,17 +6,17 @@
 使用 WeIdentity 部署工具完成部署（可视化部署方式）
 =====================================================================
 
-0. 打开 WeIdentity 部署工具的 Web 页面
+准备: 打开 WeIdentity 部署工具的 Web 页面
 """"""""""""""""""""""""""""""""""""""""""""""""""""""
 
-通过安装 “ WeIdentity 部署工具” 的服务器的公网 IP 访问 Web 页面 :code:`http://ip:6102/guide.html` 以进行 WeIdentity JAVA SDK 的部署。
+通过安装“WeIdentity 部署工具”的服务器的 IP 访问 Web 页面 :code:`http://IP:6102` 以进行 WeIdentity 的部署。
 
 .. note::
-     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>`_\
+     1. 在使用之前, 请确保已安装“WeIdentity 部署工具”, 详见文档：\ `安装 WeIdentity 部署工具 <./weidentity-installation.html>`_\。
+     2. 若无法使用 Web 页面, 可以使用命令行的方式完成部署, 详见文档：\ `部署文档(命令行部署方式) <./deploy-via-commandline.html>`_\。
+     3. 因为“WeIdentity 部署工具”没有账号登录机制，所以必须确保整个环境只有在内网（不会被其他外部用户访问到的网络）可以访问，公网的其他用户不能访问。
 
-1. 选择角色
+第0步: 选择角色
 """""""""""""""""""""""""""
 
 此步骤可选择部署时所用的角色, 包括 “联盟链委员会管理员” 和 “非联盟链委员会管理员”, 如下图所示。
@@ -26,87 +26,87 @@
 
 .. note::
      什么是“联盟链委员会管理员”?
-       一条联盟链中, 选取一家机构来作为联盟链管理员, 一般为创世节点所在机构, 此机构将作为联盟链委员会管理员来管理此链中使用的WeID相关合约。
+       一条联盟链中，选取一家机构来作为联盟链委员会管理员，此机构将会管理和运维此联盟链，并负责
+       完成 WeIdentity 智能合约的部署。举个例子，一条联盟链有4个机构，其中一个机构可以作为联盟链委员会管理员，其他则是联盟链委员会普通成员。
 
-2. 配置区块链节点
+第1步: 配置区块链节点
 """""""""""""""""""""""""""
 
-此步骤将配置需连接的区块链节点(:download:`点击下载配置示例 <./samples/run.config.sample>`), 如下图所示。
+此步骤将配置需连接的区块链节点, 如下图所示。
 
    .. image:: images/deploy-via-web-guide-setup-blockchain.png
       :alt: deploy-via-web-guide-setup-blockchain.png
 
-   - 配置机构名称
-      * 配置说明：机构名称用于标识机构唯一性, 可作为链上存储时的唯一标识, 亦可用作机构间的 AMOP 通信标识, 还可作为联盟链成员的IssuerName。
+   - 机构名称
+      * 配置说明：机构名称用于标识机构唯一性, 类似域名的作用，在同一条联盟链上，先注册先得。例如微众，可以填入"webank"作为其机构名称。
       * 配置要求：建议使用机构的英文名称或简称, 并确保机构名称在联盟链成员中唯一。
 
-   - 配置 AMOP 通讯 ID
+   - AMOP 通讯 ID
       * 配置说明：此 ID 将作为节点间 AMOP 通讯所需要的Topic来进行监听。AMOP 通讯可在不同机构的节点间通讯, 亦可在同一机构内的不同节点间通讯。
-      * 配置要求：建议使用英文, 并确保 ID 机构唯一或 VPC 唯一。
+      * 配置要求：建议使用英文, 并确保 ID 机构唯一或 VPC 唯一。\ `「什么是 AMOP ?」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/amop_protocol.html?highlight=amop>`_\
 
-   - 配置部署环境
+   .. - 配置部署环境
       * 配置说明：目前支持三种部署环境, 生产环境, 测试环境和开发环境。不同环境可使用同一条区块链, 亦可各自使用独立的链。
       * 配置要求：请根据实际需要选择, 并确保联盟链成员的环境一致。
 
    - 配置区块链节点 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
+      * 配置说明：填入集成 WeIdentity Java SDK 的service（或者部署 WeIdentity Rest Service），所需连接的区块链节点的内网或公网 IP。Channel 端口为该节点的Channel端口。 \ `「什么是 Channel 端口?」 <https://mp.weixin.qq.com/s/XZ0pXEELaj8kXHo32UFprg>`_\
+      * 配置要求：格式为区块链节点 IP:Channel 端口。如需使用多个区块链节点, 请用半角逗号","分隔。
+      * 连接单个节点的配置示例：10.10.4.1: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。
+   - 配置 SDK 证书
+      * 配置说明：连接区块链节点时需要使用的 SDK 证书。
+      * 配置要求：登录区块链节点服务器, 生成/拷贝证书文件, 并下载到本机后上传。SDK 证书文件包括 ca.crt, node.crt 和 node.key。
 
 .. 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>`_\
+     1. \ `「如何获得 SDK 证书?」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/enterprise_tools/operation.html#get-sdk-file>`_\
+     2. \ `「区块链中的各种证书」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/certificates.html>`_\
 
-3. 选择主群组 ID
+第2步: 选择主群组
 """""""""""""""""""""""""""
 
-此步骤可选择所需使用的主群组, 如下图所示。
+如下图所示。
 
    .. image:: images/deploy-via-web-guide-choose-group-id.png
       :alt: deploy-via-web-guide-choose-group-id.png
 
    - 选择主群组 ID
-      * 配置说明：主群组编号为联盟链成员节点所共有的群组编号, 此群组编号为区块链搭建的时候联盟链成员协调出来的群组编号。
-      * 配置要求：默认主群组 ID 为 1。请确保联盟链成员选择使用一致的主群组。
+      * 配置说明：主群组是 WeIdentity 智能合约部署的群组，需要协调所有部署了区块链节点的机构选择一个群组作为主群组，所有机构的所有区块链节点都需要加入这个主群组，这样才能保证所有的WeID都是相互可见的。
+      * 如果您使用到了多群组的架构，例如整个联盟链部署了 ID 为98，101，102三个区块链群组，然后所有部署了区块链节点的机构协商选择 98 作为主群组，则这个步骤所有机构都选择98即可；
+      * 如果整个联盟链只有一个群组，则这里就选择这个唯一的群组作为主群组。
 
 .. note::
    \ `「如何查看群组?」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/console.html#getgrouplist>`_\
 
-4. 配置数据库(可选)
+第3步: 配置数据库(可选)
 """""""""""""""""""""""""""
 
-此步骤将配置所需连接的数据库环境, 请提前安装数据库并创建数据库实例及用户, 如下图所示。
+此步骤将配置所需连接的数据库环境, 请提前自行安装数据库并创建数据库实例及用户。
 
    - 配置数据库
-      * 配置说明：目前支持MySql 5.7+ 数据库。当使用 Transportation, Envidence 异步存证, Persistence 数据存储等相关功能组件时, 必需使用数据库。
-      * 配置示例: :download:`点击下载配置示例 <./samples/run.config.sample>`
+      * 配置说明：当需要使用 Transportation, Envidence 异步存证,Persistence 数据存储等相关功能组件时, 数据库才是必须的。
 
    .. image:: images/deploy-via-web-guide-setup-database.png
       :alt: deploy-via-web-guide-setup-database.png
 
-5. 创建管理员 WeID (仅限联盟链委员会管理员)
+第4步: 创建管理员 WeID
 """"""""""""""""""""""""""""""""""""""""""
 
 此步骤将配置您在 weid-build-tools 里面的 Admin 账户, 后续的部署等操作将使用该账户（请妥善保管私钥, 谨防丢失）。
 
    .. image:: images/deploy-via-web-guide-create-admin-weid.png
       :alt: deploy-via-web-guide-create-admin-weid.png
 
-6. 部署 WeIdentity 智能合约(仅限联盟链委员会管理员)
-"""""""""""""""""""""""""""""""""""""""""""""""""
+第5步: 部署 WeIdentity 智能合约（仅联盟链委员会管理员需要执行这一步骤）
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
 此步骤将部署 WeIdentity 智能合约 到指定的区块链上, 如图所示。
 
    .. image:: images/deploy-via-web-guide-deploy-weid-contract.png
       :alt: deploy-via-web-guide-deploy-weid-contract.png
 
-   - 选择链 ID (Chain Id)
+   - 配置链 ID (Chain Id)
          * 配置说明：待连接节点所属的链ID, 安装区块链时自动生成, 一般情况下无需更改。
          * 配置要求: 默认 Chain Id 为 1。
 

diff --git a/readthedocs/zh_CN/docs/weidentity-spec.rst b/readthedocs/zh_CN/docs/weidentity-spec.rst
@@ -124,7 +124,7 @@ WeIdentity DID = did:weid:chain-id:bs-specific-string
    * - weid
      - WeIdentity DID规范的method name字段，固定为“weid”
    * - chain-id
-     - 链 ID，用于路由到不同的链网络，例如同时使用 WeIdentity 的可能有多条区块链，可以使用这个字段作为标识信息，路由到特定区块链。
+     - 链 ID，用于路由到不同的链网络（如果需要跟其他链打通，需要找 WeIdentity 开源项目的 owner 微众银行注册路由信息），例如同时使用 WeIdentity 的可能有多条区块链，可以使用这个字段作为标识信息，路由到特定区块链
    * - bs-specific-string
      - 基于底层区块链平台生成，代表Entity在链上的地址，保证全网唯一