Skip to content

Commit

Permalink
* document improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
junqizhang-dev committed Jul 13, 2020
1 parent 01bcad2 commit 9b91a74
Show file tree
Hide file tree
Showing 13 changed files with 288 additions and 238 deletions.
12 changes: 12 additions & 0 deletions readthedocs/zh_CN/docs/deploy-via-commandline.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. role:: raw-html-m2r(raw)
:format: html

.. _deploy-via-commandline:

使用 WeIdentity 部署工具完成部署(命令行部署方式)
=================================================


1. 联盟链管理员: \ `参考文档 <./weidentity-build-with-deploy.html>`_\ 完成部署和配置。

2. 非联盟链管理员: \ `参考文档 <./weidentity-build-without-deploy.html>`_\ 完成配置。
83 changes: 83 additions & 0 deletions readthedocs/zh_CN/docs/deploy-via-web.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
.. role:: raw-html-m2r(raw)
:format: html

.. _deploy-via-web:

使用 WeIdentity 部署工具完成部署(可视化部署方式)
=================================================

步骤说明
--------


0. 打开 WeIdentity 部署工具的 Web 页面
""""""""""""""""""""""""""""""""""""""""""""""

* 通过安装 “WeIdentity 部署工具”的服务器的 IP 访问 Web 页面 :code:`http://ip:6102/index.html` 。

.. note::
如果还没有安装 WeIdentity 部署工具,请参考: \ `安装 WeIdentity 部署工具 <./weidentity-installation.html>`_\

.. note::
如果不方便通过网页完成部署,可以使用命令行的方式完成部署,详见文档:\ `部署文档(命令行部署方式) <./deploy-via-commandline.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编码,确认后再点击启用即可。


""""""""""""""""""""""""""""""""

1. 请访问主页通过指引来完成配置和部署合约等相关操作。

* 需要提前准备区块链节点

* 需要有可访问的MySql数据库


2. 合约部署完成将会生成相关的配置文件:

* admin密钥文件目录 : ./output/admin/

* 资源文件目录(用于应用集成SDK): ./resources/
43 changes: 35 additions & 8 deletions readthedocs/zh_CN/docs/one-stop-experience.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,44 @@ Demo体验
- \ `开始体验 <https://sandbox.webank.com/weid>`_\
- 基于WeID,将用户身份同电子身份ID对应的学历信息电子化,Hash上链,保证身份和学历信息高效验证,不可篡改

快速部署与上手
----------------
1. 安装 WeIdentity 部署工具
------------------------------

您可以参照\ `部署文档 <./weidentity-installation.html>`_\,体验WeIdentity的快速部署与上手流程
您可以参照\ `安装 WeIdentity 部署工具 <./weidentity-installation.html>`_\,安装 WeIdentity 部署工具

深入了解:SDK文档
2. 使用 WeIdentity 部署工具完成部署
---------------------------------------

参照\ `部署文档 <./deploy-via-web.html>`_\,完成部署和配置。


3. 运行 Sample 代码,体验接口(可选)
-------------------------------------------------

.. note::
如果不想体验 Sample,可以直接跳过这一步


您可以参考\ `开发样例使用 <./weidentity-sample-commandline.html>`_\,体验 WeIdentity 的各种接口。


4. 在自己的 Java Service 中集成 WeIdentity Java SDK
-----------------------------------------------------

参考:\ `集成 WeIdentity Java SDK <sdk-integration.html>`_\

.. note::
如果您是要的是其他语言而非 Java,可以参照\ `RestService文档 <./weidentity-rest.html>`_\,通过 WeIdentity Rest Service 来调用相关的接口。


其他:SDK文档
------------------

您可以参照\ `RestService文档 <./weidentity-rest.html>`_\,\ `Java SDK文档 <https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/>`_\,深入了解WeIdentity的设计与技术细节。
参考\ `Java SDK文档 <https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/>`_\,深入了解 WeIdentity 的接口调用。


其他: WeIdentity JAVA SDK 便捷工具使用
-----------------------------------------

参考实现
---------------
我们提供了一些快捷工具,可以帮您快速体验 weid-java-sdk,请参考\ `WeIdentity JAVA SDK 便捷工具使用 <./weidentity-quick-tools.html>`__\。

您可以参考\ `开发样例使用 <./weidentity-sample.html>`_\,体验WeIdentity的业务流程,并参考进行您的Java应用开发。
50 changes: 50 additions & 0 deletions readthedocs/zh_CN/docs/sdk-integration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
.. role:: raw-html-m2r(raw)
:format: html

.. _sdk-integration:

在 Java 应用中集成 WeIdentity Java SDK
=============================================================

整体介绍
--------


集成步骤
--------

1. 在自己的 Java 应用中引入 weid-java-sdk
'''''''''''''''''''''''''''''''''''''''''''''

编辑 ``build.gradle`` 文件,添加:

::

compile("com.webank:weid-java-sdk:x.x.x")

.. note::
x.x.x为您使用的weid-java-sdk版本,建议使用最新版本。 查看 \ `版本历史 <https://mvnrepository.com/artifact/com.webank/weid-java-sdk>`__



2. 配置您的 Java 应用
''''''''''''''''''''''''

将 weid-build-tools 里配置好的配置文件拷贝至您的 Java 应用中:
::

cd resources/
ls


您可以将 ``resources`` 目录下的所有文件拷贝至您的Java应用的 ``resources`` 目录下,weid-java-sdk 会自动加载相应的资源文件。



3. 集成完成
''''''''''''''''

现在您可以使用 WeIdentity 开发您的区块链身份应用。weid-java-sdk 相关接口请见:\ `WeIdentity JAVA SDK文档 <./projects/javasdk/weidentity-java-sdk-doc.html>`__ 。



68 changes: 4 additions & 64 deletions readthedocs/zh_CN/docs/weidentity-build-with-deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.. _weidentity-build-with-deploy:

WeIdentity JAVA SDK 安装部署工具(部署智能合约
使用 WeIdentity 部署工具完成部署(联盟链管理员
=============================================================

整体介绍
Expand All @@ -14,33 +14,8 @@ WeIdentity JAVA SDK 安装部署工具(部署智能合约)
* 部署 WeIdentity 智能合约的机构,参考本文档完成安装部署和集成。
* 不部署 WeIdentity 智能合约的机构,可以参考\ `WeIdentity Java SDK 安装部署工具(不部署智能合约 <./weidentity-build-without-deploy.html>`__\


部署步骤
--------


1. 部署 WeIdentity 智能合约
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


1.1 下载安装部署工具
''''''''''''''''''''''''''''''
::

git clone https://github.com/WeBankFinTech/weid-build-tools.git

该工具默认会使用最新版本的
`WeIdentity智能合约 <https://github.com/WeBankFinTech/weid-contract>`__\,该工具可以帮您发布智能合约和自动配置。


1.2 配置基本信息
1. 配置基本信息
'''''''''''''''''''''''''''''
最新版本的build-tool工具仅支持 FISCO BCOS 2.0 版本。


1.2.1 基本配置
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

::

Expand Down Expand Up @@ -89,7 +64,7 @@ WeIdentity JAVA SDK 安装部署工具(部署智能合约)
如果您使用FISCO-BCOS 2.x,且需要跨群组部署WeIdentity,请参考\ `跨群组部署WeIdentity <./how-to-deploy-w-groupid.html>`__\


1.2.2 配置节点证书和秘钥文件
2. 配置节点证书和秘钥文件
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

::
Expand All @@ -98,7 +73,7 @@ WeIdentity JAVA SDK 安装部署工具(部署智能合约)

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 部署智能合约并自动生成配置文件
3. 部署智能合约并自动生成配置文件
'''''''''''''''''''''''''''''''''''

.. raw:: html
Expand Down Expand Up @@ -152,40 +127,5 @@ FISCO BCOS 2.0请参考\ `2.0 web3sdk客户端配置 <https://fisco-bcos-documen
.. note::
一条区块链里,有一家机构负责部署 WeIdentity 智能合约,部署成功后,会将上述智能合约地址给到其他机构。

2 weid-java-sdk 的集成
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

2.1 在自己的 Java 应用中引入 weid-java-sdk
'''''''''''''''''''''''''''''''''''''''''''''

在自己的 Java 应用通过 ``build.gradle`` 引入。

::

compile("com.webank:weid-java-sdk:x.x.x")

.. note::
x.x.x为您使用的weid-java-sdk版本,建议使用最新版本。



2.2 配置您的 Java 应用
''''''''''''''''''''''''''''''''''''
将 weid-build-tools 里配置好的配置文件拷贝至您的 Java 应用中:
::

cd resources/
ls


您可以将 ``resources`` 目录下的所有文件拷贝至您的Java应用的 ``resources`` 目录下,weid-java-sdk 会自动加载相应的资源文件。

现在您可以使用 WeIdentity 开发您的区块链身份应用。weid-java-sdk 相关接口请见:\ `WeIdentity JAVA SDK文档 <./projects/javasdk/weidentity-java-sdk-doc.html>`__ 。

我们提供了一个基于WeID的 \ `开发样例 <https://github.com/WeBankFinTech/weid-sample>`__\, 您可以参考。


3. WeIdentity JAVA SDK 便捷工具使用
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

我们提供了一些快捷工具,可以帮您快速体验 weid-java-sdk,请参考\ `WeIdentity JAVA SDK 便捷工具使用 <./weidentity-quick-tools.html>`__\。

0 comments on commit 9b91a74

Please sign in to comment.