Skip to content

Commit

Permalink
Merge pull request #37 from yg3630536/master
Browse files Browse the repository at this point in the history
* fix doc for weid-build-tools 1.0.19
  • Loading branch information
junqizhang-dev committed Sep 19, 2020
2 parents 93d0bd7 + d0e9081 commit cd93540
Show file tree
Hide file tree
Showing 7 changed files with 114 additions and 17 deletions.
2 changes: 1 addition & 1 deletion readthedocs/zh_CN/docs/deploy-via-web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
准备: 打开 WeIdentity 部署工具的 Web 页面
""""""""""""""""""""""""""""""""""""""""""""""""""""""

通过安装“WeIdentity 部署工具”的服务器的 IP 访问 Web 页面 :code:`http://IP:6102` 以进行 WeIdentity 的部署。
通过安装“WeIdentity 部署工具”的服务器的 IP 访问 Web 页面 :code:`http://IP:6021` 以进行 WeIdentity 的部署。

.. note::
1. 若无法使用 Web 页面, 可以使用命令行的方式完成部署, 详见文档:\ `部署文档(命令行部署方式) <./deploy-via-commandline.html>`_\。
Expand Down
31 changes: 31 additions & 0 deletions readthedocs/zh_CN/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,3 +316,34 @@ Evidence的key是数据的hash值(通过WeIdentity SDK提供的sha3函数计
如果MYSQL有设置最大链接数,请注意将连接数设置为:业务系统连接池maxActive + SDK的maxActive。否则有可能出现数据库锁表的情况。

---


- **联盟链管理员丢失了私钥怎么办?**

在使用可视化工具过程中,如果联盟链管理员丢失了私钥,则说明当前的合约数据都不安全了,需要重新配置并部署合约,具体操作如下:

1.进入tools/目录升级链上数据桶版本

完成此操作之前请确保output/admin目录中存在新的私钥,如果没有新私钥,请先通过可视化工具配置管理员新私钥

.. code-block:: shell

cd tools
chmod u+x upgrade_databucket.sh
./upgrade_databucket.sh

2. 删除weid-build-tools指引文件

.. code-block:: shell

cd ..
rm -r output/other/guide

3. 重启服务

.. code-block:: shell

./stop.sh
./start.sh

---
2 changes: 1 addition & 1 deletion readthedocs/zh_CN/docs/weidentity-build-with-deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

::

cd weid-build-tools
cd weid-build-tools
vim run.config

- 配置区块链节点信息,填入区块链节点 IP 和 Channel端口,示例如下:
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/zh_CN/docs/weidentity-build-without-deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

::

cd weid-build-tools
cd weid-build-tools
vim run.config

- 配置区块链节点信息,填入区块链节点 IP 和 Channel端口,示例如下:
Expand Down
45 changes: 39 additions & 6 deletions readthedocs/zh_CN/docs/weidentity-installation-by-web-overseas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@ WeIdentity 安装部署工具使用文档(部署WeIdentity的服务器在海

.. code-block:: shell
wget -c https://github.com/WeBankFinTech/weid-build-tools/raw/master/common/script/install/weid-install.sh
wget -c https://github.com/WeBankFinTech/weid-build-tools/raw/master/common/script/install/weid_install.sh
2.执行安装脚本
""""""""""""""""

.. code-block:: shell
chmod u+x weid-install.sh
./weid-install.sh -t en
chmod u+x weid_install.sh
./weid_install.sh -t en
cd weid-build-tools
.. note::

- 默认会下载最新版本的可视化安装工具,如果想指定安装版本,可以执行::code:`./weid-install.sh -v 1.0.12 -t en`。
- 默认会下载最新版本的可视化安装工具,如果想指定安装版本,可以执行::code:`./weid_install.sh -v 1.0.12 -t en`。

- `-t参数`说明:指定依赖下载源,en : 指向海外的源, cn : 指向中国内地的源,国内用户建议使用 cn 或者不指定依赖源,国外用户建议使用 en。默认值是cn。

Expand All @@ -43,9 +43,42 @@ WeIdentity 安装部署工具使用文档(部署WeIdentity的服务器在海
.. code-block:: shell
the server start successfully.
the server url: http://127.0.0.1:6102/index.html
the server url: http://127.0.0.1:6021
4.安装完成
""""""""""""""

通过 IP 访问 :code:`http://ip:6102/index.html` ,将开启可视化安装部署。
通过 IP 访问 :code:`http://ip:6021` ,将开启可视化安装部署。


插件安装
----

安装fisco-bcos-browser
""""""""""""""""""""""""""""""""

安装fisco-bcos-browser前请使用可视化工具完成数据库配置。

1.执行安装脚本

.. code-block:: shell
./weid_install.sh -n webase
出现下列输出,则表示Web服务启动成功。

.. code-block:: shell
--------------------------------------------------------------------------
fisco-bcos-browser is installed successfully, please go to the fisco-bcos-browser/server directory and start the server.
Example: cd fisco-bcos-browser/server && ./start.sh
--------------------------------------------------------------------------

3.进入fisco-bcos-browser服务目录,并且启动服务

.. code-block:: shell
cd fisco-bcos-browser/server
./start.sh
4.可以通过可视化工具进行访问fisco-bcos-browser
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.. _weidentity-installation-by-sourcecode:

WeIdentity 安装部署工具使用文档(可视化安装部署方式
WeIdentity 安装部署工具使用文档(可视化源码安装部署方式
=====================================================

整体介绍
Expand Down Expand Up @@ -34,7 +34,6 @@ WeIdentity 安装部署工具使用文档(可视化安装部署方式)

.. code-block:: shell
cd WeIdentity-Build-Tools
git checkout develop
chmod u+x *.sh
3.编译项目
Expand Down
46 changes: 40 additions & 6 deletions readthedocs/zh_CN/docs/weidentity-installation-by-web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ WeIdentity 安装部署工具使用文档(可视化安装部署方式)
可视化版本只需要简单的几步就可以完成安装,其他的操作都可以在网页上面进行完成,大大降低了操作难度。

.. note::
注意: 建议在内网环境搭建安装部署。启动的可视化安装工具默认会监听6102端口,不能对外网开放访问。
注意: 建议在内网环境搭建安装部署。启动的可视化安装工具默认会监听6021端口,不能对外网开放访问。

服务器在中国内地的用户安装步骤:
---------------------------------
Expand All @@ -27,19 +27,20 @@ WeIdentity 安装部署工具使用文档(可视化安装部署方式)

.. code-block:: shell
wget -c https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/WeIdentity/weid-install.sh
wget -c https://gitee.com/WeBank/WeIdentity-Build-Tools/raw/master/common/script/install/weid_install.sh
2.执行安装脚本
"""""""""""""""

.. code-block:: shell
chmod u+x weid-install.sh; ./weid-install.sh
chmod u+x weid_install.sh
./weid_install.sh
cd weid-build-tools
.. note::
- 默认会下载最新版本的可视化安装工具,如果想指定安装版本,可以通过 :code:`-v` 指定”WeIdentity 安装部署工具“的版本号(注意,不是 WeIdentity Java SDK 的版本号),例如执行: :code:`./weid-install.sh -v 1.0.12`。
- 默认会下载最新版本的可视化安装工具,如果想指定安装版本,可以通过 :code:`-v` 指定”WeIdentity 安装部署工具“的版本号(注意,不是 WeIdentity Java SDK 的版本号),例如执行: :code:`./weid_install.sh -v 1.0.12`。
- 查看\ `“WeIdentity 部署工具”历史版本 <https://search.maven.org/artifact/com.webank/weid-build-tools>`_\

3.启动Web服务
Expand All @@ -54,14 +55,47 @@ WeIdentity 安装部署工具使用文档(可视化安装部署方式)
.. code-block:: shell
the server start successfully.
the server url: http://127.0.0.1:6102/index.html
the server url: http://127.0.0.1:6021
4.安装完成
""""""""""""""

安装已经完成,接下来:

* 可以使用可视化的方式完成 WeIdentity 的部署:通过 :code:`http://IP:6102/index.html` (IP 替换为自己服务器的IP)访问部署工具的 Web 页面,详见文档:\ `部署文档(可视化部署方式) <./deploy-via-web.html>`_\,完成 WeIdentity 的部署和其他相关配置。
* 可以使用可视化的方式完成 WeIdentity 的部署:通过 :code:`http://IP:6021` (IP 替换为自己服务器的IP)访问部署工具的 Web 页面,详见文档:\ `部署文档(可视化部署方式) <./deploy-via-web.html>`_\,完成 WeIdentity 的部署和其他相关配置。

* 也可以使用命令行的方式完成部署,详见文档:\ `部署文档(命令行部署方式) <./deploy-via-commandline.html>`_\ ,完成 WeIdentity 的部署和其他相关配置。


插件安装
----

安装fisco-bcos-browser
""""""""""""""""""""""""""""""""

安装fisco-bcos-browser前请使用可视化工具完成数据库配置。

1.执行安装脚本

.. code-block:: shell
./weid_install.sh -n webase
出现下列输出,则表示Web服务启动成功。

.. code-block:: shell
--------------------------------------------------------------------------
fisco-bcos-browser is installed successfully, please go to the fisco-bcos-browser/server directory and start the server.
Example: cd fisco-bcos-browser/server && ./start.sh
--------------------------------------------------------------------------

3.进入fisco-bcos-browser服务目录,并且启动服务

.. code-block:: shell
cd fisco-bcos-browser/server
./start.sh
4.可以通过可视化工具进行访问fisco-bcos-browser

0 comments on commit cd93540

Please sign in to comment.