Skip to content

Commit

Permalink
Merge pull request #44 from yanggang-JV/feature/add-doc-for-weid-and-…
Browse files Browse the repository at this point in the history
…webase

add doc for webase
  • Loading branch information
yanggang-JV committed Apr 6, 2021
2 parents fb40cec + 7bf51d4 commit 37b2c78
Show file tree
Hide file tree
Showing 10 changed files with 60 additions and 18 deletions.
78 changes: 60 additions & 18 deletions readthedocs/zh_CN/docs/deploy-via-web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,33 @@
1. 若无法使用 Web 页面, 可以使用命令行的方式完成部署, 详见文档:\ `部署文档(命令行部署方式) <./deploy-via-commandline.html>`_\。
2. 因为“WeIdentity 部署工具”没有账号登录机制,所以必须确保整个环境只有在内网(不会被其他外部用户访问到的网络)可以访问,公网的其他用户不能访问。

.. _mode-selection:

第1步: 选择集成模式
"""""""""""""""""""""""""""

此步骤可选择配置WeIdentity的方式,包括 “WeID原始模式” 和 “WeID + WeBase集成模式”:

“WeID原始模式”, 如下图所示。

.. image:: images/weid-build-tools-original-step1.png
:alt: weid-build-tools-original-step1.png


“WeID + WeBase集成模式”, 如下图所示:

.. image:: images/weid-build-tools-and-webase-step1.png
:alt: weid-build-tools-and-webase-step1.png

- 粘贴区
* 配置说明:此配置从【WeBase管理台】-【应用管理】中找到对应的应用,通过复制应用的注册信息到粘贴区进行粘贴即可,如果没有部署WeBase管理台,请先\ `「部署WeBase管理台」 <https://webasedoc.readthedocs.io/zh_CN/latest/docs/WeBASE/install.html>`_\。

.. note::
如果WeBase跟WeID非同机部署,请自行修改IP地址为WeBase的后台服务IP地址。

.. _role-selection:

第0步: 选择角色
第2步: 选择角色
"""""""""""""""""""""""""""

此步骤可选择部署时所用的角色, 包括 “联盟链委员会管理员” 和 “非联盟链委员会管理员”, 如下图所示。
Expand All @@ -34,13 +58,20 @@

.. _blockchain-configuration:

第1步: 配置区块链节点
第3步: 配置区块链节点
"""""""""""""""""""""""""""

此步骤将配置需连接的区块链节点, 如下图所示。
此步骤将配置需连接的区块链节点。

“WeID原始模式”, 如下图所示:

.. image:: images/weid-build-tools-original-step3.png
:alt: weid-build-tools-original-step3.png

.. image:: images/deploy-via-web-guide-setup-blockchain.png
:alt: deploy-via-web-guide-setup-blockchain.png
“WeID + WeBase集成模式”, 如下图所示:

.. image:: images/weid-build-tools-and-webase-step3.png
:alt: weid-build-tools-and-webase-step3.png

- 机构名称
* 配置说明:机构名称用于标识机构唯一性, 类似域名的作用,在同一条联盟链上,先注册先得。例如微众,可以填入"WeBank"作为其机构名称。
Expand All @@ -50,10 +81,6 @@
* 配置说明:此 ID 将作为节点间 AMOP 通讯所需要的Topic来进行监听。AMOP 通讯可在不同机构的节点间通讯, 亦可在同一机构内的不同节点间通讯。
* 配置要求:建议使用英文, 并确保该 ID 在联盟链中唯一。\ `「什么是 AMOP ?」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/amop_protocol.html?highlight=amop>`_\

.. - 配置部署环境
* 配置说明:目前支持三种部署环境, 生产环境, 测试环境和开发环境。不同环境可使用同一条区块链, 亦可各自使用独立的链。
* 配置要求:请根据实际需要选择, 并确保联盟链成员的环境一致。
- 配置区块链节点 IP 和 Channel 端口
* 配置说明:填入集成 WeIdentity Java SDK 的service(或者部署 WeIdentity Rest Service),所需连接的区块链节点的内网或公网 IP。Channel 端口为该节点的Channel端口。 \ `「什么是 Channel 端口?」 <https://mp.weixin.qq.com/s/XZ0pXEELaj8kXHo32UFprg>`_\
* 配置要求:格式为区块链节点 IP:Channel 端口。如需使用多个区块链节点, 请用半角逗号","分隔。
Expand All @@ -66,15 +93,14 @@
* 配置说明:连接区块链节点时需要使用的 SDK 证书。
* 请从您的FISCO-BCOS节点安装目录获取 SDK 证书文件(包括三个文件:ca.crt, node.crt 和 node.key), 可能正在下面两个目录: ``~/fisco/nodes/127.0.0.1/sdk/`` 或 ``~/fisco/generator/tmp_one_click/agencyA/sdk/``。



.. note::
1. 对证书有疑问,可以参看这篇文章: \ `「区块链中的各种证书详解」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/certificates.html>`_\

2. “WeID + WeBase集成模式”下,可通过查询按钮,查询到WeBase中的节点信息进行配置。
3. “WeID + WeBase集成模式”下,其证书自动从WeBase中同步。

.. _group-selection:

第2步: 选择主群组
第4步: 选择主群组
"""""""""""""""""""""""""""

如下图所示。
Expand All @@ -92,7 +118,7 @@

.. _db-configuration:

第3步: 配置数据库(可选)
第5步: 配置数据库(可选)
"""""""""""""""""""""""""""

此步骤将配置所需连接的数据库环境, 请提前自行安装数据库并创建数据库实例及用户。
Expand All @@ -105,30 +131,46 @@

.. _weid-create:

第4步: 创建机构的 WeID
第6步: 创建机构的 WeID
""""""""""""""""""""""""""""""""""""""""""

此步骤将为机构创建 WeID, 后续的合约部署,发交易等操作将使用该账户(请妥善保管私钥, 谨防丢失)。


“WeID原始模式”, 如下图所示:

- 推荐"系统自动创建公私钥":在部署工具的安装目录下,有一个目录: `./output/admin/`, 会存放自动生成的私钥文件, 请妥善保管。

.. image:: images/deploy-via-web-guide-create-admin-weid.png
:alt: deploy-via-web-guide-create-admin-weid.png

“WeID + WeBase集成模式”, 如下图所示:

- 此处选择"WeBase同步账户":在部署工具的安装目录下,有一个目录: `./output/admin/`, 会存放从WeBase同步的私钥文件, 请妥善保管。

.. image:: images/weid-build-tools-and-webase-step6.png
:alt: weid-build-tools-and-webase-step6.png

.. note::
1. “WeID + WeBase集成模式”下,选择前两种创建账户方式,其私钥将同步到WeBase中存储。

.. _weid-deploy:

第5步: 部署 WeIdentity 智能合约(仅联盟链委员会管理员需要执行这一步骤)
第7步: 部署 WeIdentity 智能合约(仅联盟链委员会管理员需要执行这一步骤)
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

此步骤将部署 WeIdentity 智能合约到指定的区块链上, 如图所示。

.. image:: images/deploy-via-web-guide-deploy-weid-contract.png
:alt: deploy-via-web-guide-deploy-weid-contract.png
.. image:: images/weid-build-tools-and-webase-step7.png
:alt: weid-build-tools-and-webase-step7.png

- 配置链 ID (chain-id)
* 配置说明:\ `「什么是链 ID (Chain Id) ?」 <./weidentity-spec.html#id4>`_\
* 如果是为了测试或者体验部署工具流程,可以填入一个随意的数字,例如1000。

- 应用名
* 配置说明:当前部署的合约所属应用名字。

最后
""""""""""""""""""""""""""""""""""""""""""

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 37b2c78

Please sign in to comment.