Merge pull request #57 from yanggang-JV/master

优化开发者安装部署文档

readthedocs/zh_CN/docs/how-to-run-unit-test.rst

@@ -14,7 +14,13 @@ LINUX 系统上通过 gradle 执行单元测试
 流程
 ~~~~
 
-下载源代码进行安装部署后，以 ``weid-java-sdk`` 根目录为起点：
+下载源代码进行安装部署后，以 ``WeIdentity`` 根目录为起点：
+
+1, 拷贝秘钥文件到 ``src/test/resources`` 目录。
+
+.. code:: shell
+
+   cp ecdsa_key src/test/resources/
 
 1, 进入dist/conf目录。
 
@@ -40,16 +46,12 @@ LINUX 系统上通过 gradle 执行单元测试
 
 4, 将字体 ``NotoSansCJKtc-Regular.ttf`` 复制到 ``src/test/resources`` 目录，并进行字体安装。
 
-.. code:: shell
-
-   cp ../lib/NotoSansCJKtc-Regular.ttf  ../../src/test/resources/
-
 注：字体安装请参照 \ `技术问题列表 <./faq.html>`__\  中的字体安装说明。
 
 5, 回到项目根目录，执行测试命令。
 
 .. code:: shell
 
    cd ../../
-   gradle test
+   ./gradlew test
 

readthedocs/zh_CN/docs/weidentity-installation-by-sourcecode.rst

@@ -23,8 +23,25 @@ WeIdentity JAVA SDK安装部署文档（源码方式）
 
   git clone https://github.com/WeBankBlockchain/WeIdentity.git
 
+或者
+
+.. code-block:: shell
+
+  git clone https://gitee.com/WeBank/WeIdentity.git
+
 WeIdentity Java SDK 工程见\ `WeIdentity JAVA SDK <https://github.com/WeBankBlockchain/WeIdentity.git>`_\ :raw-html-m2r:`<br>`
 
+- WeIdentity 编译
+
+.. code-block:: shell
+
+  cd WeIdentity
+  chmod u+x ./gradlew
+  ./gradlew build -x test
+
+.. note::
+     如果出现 xx SpotBugs violations were found 这个提示，请忽略。
+
 - 配置节点证书和秘钥文件
 
 ::
@@ -49,12 +66,15 @@ WeIdentity Java SDK 工程见\ `WeIdentity JAVA SDK <https://github.com/WeBankBl
 -  配置说明：
 
  | ``blockchain_address`` ： 区块链节点 IP 和channel端口， channel端口的配置可以参考\ `FISCO BCOS 2.0 配置项说明 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/configuration.html#rpc>`__ 进行配置。
- | ``org_id`` ：机构名称，该名称也被用作后续机构间的通信标识。
+ | ``amop_id`` ：机构间的通信标识。
+ | ``org_id`` ：机构名称。
  | ``chain_id`` ：用于标识您接入的区块链网络。
+ | ``persistence_type`` ：数据存储类型。
  | ``mysql_address`` ：配置数据库的ip和port，例：0.0.0.0:3306
  | ``mysql_database`` ：配置数据库名称
  | ``mysql_username`` ：配置数据库用户名
  | ``mysql_password`` ：配置数据库用户对应的密码
+ | ``cns_profile_active`` ：合约部署环境标识,可用于WeIdentity合约隔离
 
 
 配置样例：
@@ -63,12 +83,18 @@ WeIdentity Java SDK 工程见\ `WeIdentity JAVA SDK <https://github.com/WeBankBl
     #节点的连接串，节点IP为10.10.10.10，和channel端口为20200。
     blockchain_address=10.10.10.10:20200
 
+    #机构间的通信标识
+    amop_id=organizationA
+
     #机构名称
     org_id=organizationA
 
     #链标识
-    chain_id=1
-
+    chain_id=101
+    
+    #数据存储类型
+    persistence_type=mysql
+    
     #数据库ip和port
     mysql_address=0.0.0.0:3306
 
@@ -81,6 +107,9 @@ WeIdentity Java SDK 工程见\ `WeIdentity JAVA SDK <https://github.com/WeBankBl
     #数据库密码
     mysql_password=password
 
+    #合约部署环境标识
+    cns_profile_active=prdA
+
 .. note::
      注意：如果您使用了Gradle 6.0+，那么您需要手动修改build.gradle中spotbug的Gradle插件版本号为2.0.0+。具体地，打开WeIdentity/build.gradle，将“classpath "gradle.plugin.com.github.spotbugs:spotbugs-gradle-plugin:1.6.5"”中的1.6.5改成2.0.0或更高版本。
 
@@ -109,6 +138,9 @@ WeIdentity Java SDK 工程见\ `WeIdentity JAVA SDK <https://github.com/WeBankBl
 
 到这里，您已经完成了weid-java-sdk的安装和部署的全部步骤，您可以开始使用WeIdentity来构建您的分布式身份管理的Java应用了。
 
+.. note::
+    如果执行部署过程中出现 160016 - no premission for this cns. 异常，请修改(run.config)中的配置项  cns_profile_active 的值，修改成一个独有的值即可, 如：cns_profile_active=test456。
+
 Have fun!!!
 
 备注