部署说明

1. 前提条件

依赖软件支持版本
JavaOracle JDK 8至14
FISCO-BCOSv2.0.0及以上版本

备注： Java推荐使用OracleJDK，可参考JDK配置指引（CentOS的yum仓库的OpenJDK缺少JCE(Java Cryptography Extension)，导致Web3SDK无法正常连接区块链节点）

国密支持

WeBASE-Front v1.2.2+已支持 国密版FISCO-BCOS

  • 在v1.5.0后，sdk将自动根据链的加密类型切换国密或非国密，自动根据链的SSL类型切换国密SSL

solidity v0.6.10支持

WeBASE-Front v1.4.2已支持solidity v0.5.1和v0.6.10

2. 拉取代码

执行命令：

  1. git clone https://github.com/WeBankBlockchain/WeBASE-Front.git
  3. # 若因网络问题导致长时间下载失败，可尝试以下命令
  4. git clone https://gitee.com/WeBank/WeBASE-Front.git

进入目录：

  1. cd WeBASE-Front

3. 编译代码

使用以下方式编译构建，如果出现问题可以查看 常见问题解答 ：

方式一：如果服务器已安装Gradle，且版本为gradle-4.10至gradle-6.x版本

  1. gradle build -x test

方式二：如果服务器未安装Gradle，或者版本不是gradle-4.10至gradle-6.x版本，可使用gradlew编译

  1. chmod +x ./gradlew && ./gradlew build -x test

构建完成后，会在根目录WeBASE-Front下生成已编译的代码目录dist。

4. 修改配置

（1）进入dist目录

  1. cd dist

dist目录提供了一份配置模板conf_template：

  1. 根据配置模板生成一份实际配置conf。初次部署可直接拷贝。
  2. 例如：cp -r conf_template conf

（2）进入conf目录：

  1. cd conf

注意： 将节点所在目录nodes/${ip}/sdk下的所有文件拷贝到当前conf目录，供SDK与节点建立连接时使用（SDK会自动判断是否为国密，且是否使用国密SSL）

  • 链的sdk目录包含了ca.crt, sdk.crt, sdk.key和gm文件夹，gm文件夹包含了国密SSL所需的证书
  • 拷贝命令可使用cp -r nodes/${ip}/sdk/* ./conf/
  • 注，只有在建链时手动指定了-G(大写)时节点才会使用国密SSL

（3）修改配置（根据实际情况修改）：

如果在企业部署中使用WeBASE-Front，必须配置下文中的keyServer，用于连接WeBASE-Sign服务

  1. vi application.yml
  1. spring:
  2.   datasource:
  3.     url: jdbc:h2:file:./h2/webasefront;DB_CLOSE_ON_EXIT=FALSE // 默认H2库为webasefront，建议修改数据库存放路径
  4. ...
  5. server: 
  6.   port: 5003                    // 服务端口
  7.   context-path: /WeBASE-Front
  8. sdk: 
  9.   ...
  10.   ip: 127.0.0.1                 // 连接节点的监听ip
  11.   channelPort: 20200            // 连接节点的链上链下端口
  12.   certPath: conf                // sdk证书的目录，默认为conf
  13. constant: 
  14.   keyServer: 127.0.0.1:5004     // 密钥服务的IP和端口(WeBASE-Node-Manager服务或者WeBASE-Sign服务，不同服务支持的接口不同)，如果作为独立控制台使用可以不配置
  15.   aesKey: EfdsW23D23d3df43          // aes加密key(16位) 如启用，各互联的子系统的加密key需保持一致
  16.   transMaxWait: 30              // 交易最大等待时间
  17.   monitorDisk: /                // 要监控的磁盘目录，配置节点所在目录（如：/data）
  18.   monitorEnabled: true          // 是否监控数据，默认true
  19.   nodePath: /fisco/nodes/127.0.0.1/node0      //配置所连节点的绝对路径，用于监控节点配置与日志
  20. ...

5. 服务启停

返回到dist目录执行：

  1. 启动: bash start.sh
  2. 停止: bash stop.sh
  3. 检查: bash status.sh

备注：服务进程起来后，需通过日志确认是否正常启动，出现以下内容表示正常；如果服务出现异常，确认修改配置后，重启提示服务进程在运行，则先执行stop.sh，再执行start.sh。

启动成功将出现如下日志：

  1. ...
  2.     Application() - main run success...

6. 访问控制台

  1. http://{deployIP}:{frontPort}/WeBASE-Front
  2. 示例：http://localhost:5002/WeBASE-Front
  • 部署服务器IP和服务端口需对应修改，网络策略需开通
  • 基于可视化控制台，可以开发智能合约，部署合约和发送交易，并查看交易和区块详情。还可以管理私钥，对节点健康度进行监控和统计

7. 查看日志

在dist目录查看：

  1. 前置服务全量日志：tail -f log/WeBASE-Front.log
  2. 前置服务错误日志：tail -f log/WeBASE-Front.log
  3. web3连接日志：tail -f log/web3sdk.log