Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.4.0 dev=>master #225

Merged
merged 67 commits into from
Aug 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
d937d7b
update requirements
yuanmomo Jul 11, 2020
edc578f
add visual deploy
yuanmomo Jul 12, 2020
a2a2b55
update format
yuanmomo Jul 12, 2020
d2a78fd
update format
yuanmomo Jul 12, 2020
8ea5324
update visal deploy
yuanmomo Jul 18, 2020
18935bd
refact
yuanmomo Jul 26, 2020
43a085b
update
yuanmomo Jul 26, 2020
06a0dbe
add visual deploy
yuanmomo Jul 27, 2020
9ee6ca6
update doc
yuanmomo Jul 27, 2020
f0ea5a1
update link
yuanmomo Jul 27, 2020
48dbb4c
update deploy.py choice
yuanmomo Jul 27, 2020
ba5c283
update visual deploy
yuanmomo Jul 27, 2020
92d93e4
update
yuanmomo Aug 2, 2020
ae4fb8f
update format
yuanmomo Aug 2, 2020
be527e3
update png
yuanmomo Aug 2, 2020
079bfb0
update png
yuanmomo Aug 2, 2020
2cd43f1
delete visual-deploy-architecture png
yuanmomo Aug 3, 2020
f2f7ee0
optimize doc reading
CodingCattwo Aug 3, 2020
88e6297
Merge pull request #1 from CodingCattwo/patch-1
yuanmomo Aug 3, 2020
ad32c7f
change install
yuanmomo Aug 3, 2020
088222f
fix png
yuanmomo Aug 3, 2020
cecb635
fix png
yuanmomo Aug 3, 2020
9053e3a
1. change version to 1.4.0
yuanmomo Aug 7, 2020
5eef2a7
Merge branch 'master' of https://github.com/WeBankFinTech/WeBASE-Doc …
yuanmomo Aug 7, 2020
86359fd
add docker guomi image url
yuanmomo Aug 7, 2020
96504a8
update front trans interface
CodingCattwo Aug 7, 2020
33cd274
Merge pull request #217 from yuanmomo/release/add-visual-deploy
CodingCattwo Aug 7, 2020
bb9e13a
update desc
CodingCattwo Aug 7, 2020
a80bf64
Merge pull request #218 from CodingCattwo/dev
yuanmomo Aug 7, 2020
04e732b
1. add visual deploy properties file
yuanmomo Aug 7, 2020
533d767
Merge branch 'dev' of https://github.com/WeBankFinTech/WeBASE-Doc int…
yuanmomo Aug 7, 2020
b91de85
support 2.5.x desc
CodingCattwo Aug 10, 2020
c4cd91e
optimize visual doc
CodingCattwo Aug 10, 2020
fccdb4f
Update index.md
CodingCattwo Aug 10, 2020
562fbcf
fix visual desc
CodingCattwo Aug 10, 2020
16c52c8
Merge branch 'dev' of https://github.com/CodingCattwo/WeBASE-Doc into…
CodingCattwo Aug 10, 2020
e7058eb
Merge pull request #219 from CodingCattwo/dev
yuanmomo Aug 10, 2020
a98cd50
add version in interface doc
CodingCattwo Aug 10, 2020
eb8c2c2
update version response
CodingCattwo Aug 10, 2020
9d29403
add default front port & default account pwd
CodingCattwo Aug 11, 2020
6da2eb2
add default description in suit doc
CodingCattwo Aug 11, 2020
e06918a
Merge pull request #220 from CodingCattwo/dev
yuanmomo Aug 11, 2020
51a0b74
Merge branch 'dev' of https://github.com/WeBankFinTech/WeBASE-Doc int…
yuanmomo Aug 11, 2020
b9f2bf6
add visual deploy api in WeBASE-Node-Manager
yuanmomo Aug 11, 2020
02561a7
reset webase changelog
yuanmomo Aug 11, 2020
5a5c699
add platform desc
CodingCattwo Aug 12, 2020
a91a346
optimize desc
CodingCattwo Aug 12, 2020
1f744fb
update png
yuanmomo Aug 13, 2020
13b2ce9
update front/find api
yuanmomo Aug 17, 2020
b4a3173
update description
yuanmomo Aug 17, 2020
c3ac3cc
change installVisual to installWeBASE
yuanmomo Aug 17, 2020
43cb0f2
Merge pull request #221 from yuanmomo/release/add-visual-deploy
CodingCattwo Aug 18, 2020
0d1cbfa
Merge remote-tracking branch 'upstream/dev' into dev
CodingCattwo Aug 18, 2020
d94992c
add cdn desc
CodingCattwo Aug 18, 2020
cf1b1a7
Merge pull request #222 from CodingCattwo/dev
yuanmomo Aug 18, 2020
f8f9e01
add gitee desc
CodingCattwo Aug 18, 2020
4cc3df6
Merge pull request #223 from CodingCattwo/dev
yuanmomo Aug 18, 2020
25d2fcd
change visualDeploy to installWeBASE
yuanmomo Aug 18, 2020
aa8d279
fix
yuanmomo Aug 19, 2020
2127a49
Merge branch 'dev' of https://github.com/WeBankFinTech/WeBASE-Doc int…
yuanmomo Aug 19, 2020
6cd3802
replace cdn to tencent cloud
yuanmomo Aug 19, 2020
da1c161
update cdn description
yuanmomo Aug 19, 2020
0732662
update cdn description
yuanmomo Aug 19, 2020
7ec167f
update cdn description
yuanmomo Aug 19, 2020
f10286a
add event_subscribe url
yuanmomo Aug 19, 2020
b5ebab5
delete #
yuanmomo Aug 19, 2020
3e96dac
Merge pull request #224 from yuanmomo/release/add-visual-deploy
CodingCattwo Aug 19, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ _build
*.ipr
*.iws
.DS_Store
.vscode/
.vscode/
src
4 changes: 2 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@
# built documents.
#
# The short X.Y version.
version = '1.3'
version = '1.4'
# The full version, including alpha/beta/rc tags.
release = 'v1.3.2'
release = 'v1.4.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
29 changes: 24 additions & 5 deletions docs/WeBASE-Console-Suit/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ WeBASE管理平台是由四个WeBASE子系统组成的一套管理FISCO-BCOS联

WeBASE管理平台分为四个部分:节点前置,签名服务,节点管理,WeBASE管理台。

当前版本我们提供了两种搭建方式:[**一键搭建**](../WeBASE/install.md)和手动搭建
当前版本我们提供了三种搭建方式:[**一键搭建**](../WeBASE/install.md)、纯手动搭建各子系统、[可视化部署](../WeBASE-Install/visual_deploy.md)

#### 1、一键搭建

Expand All @@ -67,13 +67,32 @@ WeBASE管理平台分为四个部分:节点前置,签名服务,节点管

WeBASE管理台使用框架`vue-cli`,具体搭建流程参见[《WeBASE管理平台安装说明》](../WeBASE-Web/install.md)。

#### 3、可视化部署

可视化部署的具体使用方法搭建流程参见[《WeBASE 可视化部署》](../WeBASE-Install/visual_deploy.md)。

可视化部署是指通过 WeBASE 管理平台的Web页面上通过可视化的操作,快速在**多台**主机上完成**FISCO-BCOS 底层节点和 WeBASE-Front 前置**的部署操作。

**可视化部署分为部署子系统和搭链两个步骤:**

- 步骤一:部署子系统依赖服务,包括管理平台(WeBASE-Web)、节点管理子系统(WeBASE-Node-Manager)、签名服务(WeBASE-Sign)。依赖服务可以通过 **一键搭建** 或 **手动搭建** 完成。

- 使用**一键搭建**的`installWeBASE`命令,一键部署依赖服务

- **手动搭建**部署依赖服务,参考上文的各子系统搭建指引

- 步骤二:使用WeBASE-Web界面搭链,部署 **FISCO-BCOS 底层节点** 和 **节点前置服务(WeBASE-Front)**

## 系统初始化配置

服务搭建成功后,可使用网页浏览器访问nginx配置的WeBASE管理台IP和端口(例如XXX.XXX.XXX.XXX:XXXX),进入到管理平台页面。管理平台默认用户为admin,默认密码为Abcd1234(第一次登陆成功后会要求重置密码,请按照密码标准设置一个更加安全的密码)。
服务搭建成功后,可使用网页浏览器访问nginx配置的WeBASE管理台IP和端口(例如`127.0.0.1:5000`),进入到管理平台页面。

管理平台默认用户为`admin`,默认密码为`Abcd1234`(第一次登陆成功后会要求重置密码,请按照密码标准设置一个更加安全的密码)。

### 添加节点前置

未初始化节点前置的管理平台,会引导去节点管理页面添加节点前置。
未初始化节点前置的管理平台,会引导去节点管理页面添加节点前置。
- 节点前置服务需要填写前置的IP与端口(默认为`127.0.0.1`和`5002`),机构名则根据实际自定义填写

![](../../images/WeBASE-Console-Suit/node_manager_add_front_2.png)

Expand Down Expand Up @@ -207,7 +226,7 @@ CRUD:CRUD通过在Solidity合约中支持分布式存储预编译合约,可

系统管理目前支持权限管理、系统配置管理、证书管理的功能。

**权限管理**:支持链权限管理和普通权限(四种)管理:
**权限管理**:支持链权限管理和普通权限(四种)管理:(基于FISCO BCOS 2.0.0 - 2.4.x的权限管理)
- 链权限管理为分配权限的链管理员,可以使用权限分配功能,非链管理员账户无权限分配功能;
- 普通权限管理包含四种权限: 部署合约和创建用户表权限, 节点管理权限, CNS管理权限, 系统参数管理权限;

Expand Down Expand Up @@ -346,7 +365,7 @@ FISCO-BCOS证书说明可以参考FISCO-BCOS使用手册的[证书说明](https:

### 订阅事件

订阅事件管理:可查看前置中已订阅的链上事件通知,包括出块事件列表和合约Event事件列表
订阅事件管理:可查看前置中已订阅的链上事件通知,包括出块事件列表和合约Event事件列表。详情请参考[节点前置-链上事件订阅和通知](../WeBASE-Front/appendix.html#event_subscribe)

出块事件列表:

Expand Down
1 change: 1 addition & 0 deletions docs/WeBASE-Front/appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,7 @@ public void loadPrivateKeyTest() {

```

<span id="event_subscribe"></span>
## 4. 支持链上事件订阅和通知

在某些业务场景中,应用层需要实时获取链上的事件,如出块事件、合约Event事件等。应用层通过WeBASE连接节点后,**由于无法和节点直接建立长连接**,难以实时获取链上的消息。
Expand Down
88 changes: 83 additions & 5 deletions docs/WeBASE-Front/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -3113,10 +3113,10 @@ HTTP POST
| 2 | 合约名称 | contractName | String | | 是 | |
| 3 | 合约地址 | contractAddress | String | | 是 | |
| 4 | 方法名 | funcName | String | | 是 | |
| 5 | 合约编译后生成的abi文件内容 | contractAbi | List | | 是 | JSONArray,如果传入此字段,则使用这个abi。如果没有传入此字段,则从db或cns获取合约abi |
| 5 | 合约编译后生成的abi文件内容 | contractAbi | List | | 是 | 合约中单个函数的ABI,若不存在同名函数可以传入整个合约ABI,格式:JSONArray |
| 6 | 方法参数 | funcParam | List | | 否 | JSON数组,多个参数以逗号分隔(参数为数组时同理),如:["str1",["arr1","arr2"]],根据所调用的合约方法判断是否必填 |
| 7 | 群组ID | groupId | int | | 是 | 默认为1 |
| 8 | 合约版本 | version | String | | 否 | |
| 8 | 合约版本 | version | String | | 否 | CNS中合约版本,该字段在v1.3.0+版本已弃用 |
| 9 | 合约路径 | contractPath | int | | 否 | |

**2)数据格式**
Expand Down Expand Up @@ -3215,10 +3215,10 @@ HTTP POST
| 2 | 合约名称 | contractName | String | | 是 | |
| 3 | 合约地址 | contractAddress | String | | 是 | |
| 4 | 方法名 | funcName | String | | 是 | |
| 5 | 合约编译后生成的abi文件内容 | contractAbi | List | | | JSONArray,如果传入此字段,则使用这个abi。如果没有传入此字段,则从db或cns获取合约abi |
| 5 | 合约编译后生成的abi文件内容 | contractAbi | List | | | 合约中单个函数的ABI,若不存在同名函数可以传入整个合约ABI,格式:JSONArray |
| 6 | 方法参数 | funcParam | List | | 否 | JSON数组,多个参数以逗号分隔(参数为数组时同理),如:["str1",["arr1","arr2"]] |
| 7 | 群组ID | groupId | int | | 是 | 默认为1 |
| 8 | 合约版本 | version | String | | 否 | CNS中的合约版本,不传入contractAbi时可传入合约地址与版本获取CNS上存储的合约ABI |
| 8 | 合约版本 | version | String | | 否 | CNS中合约版本,该字段在v1.3.0+版本已弃用 |


**2)数据格式**
Expand All @@ -3227,7 +3227,7 @@ HTTP POST
{
"groupId" :1,
"signUserId": "458ecc77a08c486087a3dcbc7ab5a9c3",
"contractAbi":[],
"contractAbi":[{"constant":true,"inputs":[],"name":"getVersion","outputs":[{"name":"","type":"string"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[],"name":"getStorageCell","outputs":[{"name":"","type":"string"},{"name":"","type":"string"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"name":"n","type":"string"}],"name":"setVersion","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"inputs":[{"name":"storageHash","type":"string"},{"name":"storageInfo","type":"string"}],"payable":false,"stateMutability":"nonpayable","type":"constructor"}],
"contractAddress":"0x14d5af9419bb5f89496678e3e74ce47583f8c166",
"funcName":"set",
"funcParam":["test"]
Expand Down Expand Up @@ -5131,6 +5131,84 @@ a、成功:
```


### 10.2. 查询WeBASE-Front版本

#### 接口描述

获取WeBASE-Front的版本号

#### 接口URL

**http://localhost:5002/WeBASE-Front/version**

#### 调用方法

HTTP GET

#### 请求参数

**1)参数表**

| **序号** | **中文** | **参数名** | **类型** | **最大长度** | **必填** | **说明** |
| -------- | -------------- | --------------- | -------- | ------------ | -------- | ---------------------------------------------- |
| | - | - | - | | | |

**2)数据格式**

```
http://localhost:5002/WeBASE-Front/version
```

#### 响应参数

**1)数据格式**

a、成功:

```
v1.4.0
```


### 10.3. 查询前置连接的WeBASE-Sign版本

#### 接口描述

获取WeBASE-Front的所连接的WeBASE-Sign的版本号

#### 接口URL

**http://localhost:5002/WeBASE-Front/version/sign**

#### 调用方法

HTTP GET

#### 请求参数

**1)参数表**

| **序号** | **中文** | **参数名** | **类型** | **最大长度** | **必填** | **说明** |
| -------- | -------------- | --------------- | -------- | ------------ | -------- | ---------------------------------------------- |
| | - | - | - | | | |

**2)数据格式**

```
http://localhost:5002/WeBASE-Front/version/sign
```

#### 响应参数

**1)数据格式**

a、成功:

```
v1.4.0
```


## 11. 附录

### 1. 返回码信息列表
Expand Down
5 changes: 5 additions & 0 deletions docs/WeBASE-Front/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

WeBASE-Front升级的兼容性说明,请结合[WeBASE-Front Changelog](https://github.com/WeBankFinTech/WeBASE-Front)进行阅读

#### v1.4.0

##### 增加版本号接口
- 增加返回 WeBASE-Front 和 WeBASE-Sign 版本号接口

#### v1.3.2

##### 移除fastjson
Expand Down
4 changes: 1 addition & 3 deletions docs/WeBASE-Install/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

节点搭建的方法建议使用[build_chain](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/installation.html)。

*注:目前WeBASE支持FISCO BCOS v2.4.x版本,暂未支持FISCO BCOS 2.5.x*

### 1.2 节点前置服务(WeBASE-Front)搭建
**前提条件**

Expand All @@ -19,7 +17,7 @@

1. 下载安装包
```shell
wget https://www.fisco.com.cn/cdn/webase/releases/download/v1.3.2/webase-front.zip
wget https://osp-1257653870.cos.ap-guangzhou.myqcloud.com/WeBASE/releases/download/v1.4.0/webase-front.zip
```


Expand Down
3 changes: 2 additions & 1 deletion docs/WeBASE-Install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

企业部署:在生产环境中,建议用户参考详细安装,部署全部功能,保证系统高效和稳定。


可视化部署:先部署 WeBASE 服务,然后通过可视化的界面操作来部署区块链底层(FISCO-BCOS 节点),完成区块链的部署操作,适用于本机部署,多主机部署场景。

```eval_rst
.. toctree::
Expand All @@ -25,4 +25,5 @@
../WeBASE-Install/developer.md
../WeBASE/install.md
../WeBASE-Install/enterprise.md
../WeBASE-Install/visual_deploy.md
```
Loading