Update README.md

This commit is contained in:
Lin Yuying
2023-05-22 15:07:45 +08:00
committed by GitHub
parent 4917f00ce9
commit 4aadf76611

View File

@@ -4,14 +4,14 @@
</p>
<p>
<img alt="Version" src="https://img.shields.io/badge/version-2.7.1-blue.svg?cacheSeconds=2592000" />
<a href="http://www.fizzgate.com/fizz-gateway-community/" target="_blank">
<a href="http://www.fizzgate.com/fizz-gateway-node/" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<a href="#" target="_blank">
<img alt="License: AGPL--3.0" src="https://img.shields.io/badge/License-AGPL--3.0-yellow.svg" />
</a>
<a href="https://github.com/fizzgate/fizz-gateway-community/actions" target="_blank">
<img alt="Java CI with Maven" src="https://github.com/fizzgate/fizz-gateway-community/workflows/Java%20CI%20with%20Maven/badge.svg?branch=master" />
<a href="https://github.com/fizzgate/fizz-gateway-node/actions" target="_blank">
<img alt="Java CI with Maven" src="https://github.com/fizzgate/fizz-gateway-node/workflows/Java%20CI%20with%20Maven/badge.svg?branch=master" />
</a>
</p>
@@ -77,19 +77,19 @@ API地址http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
| :------------------ | :------------------ | :-------: | :-------: | :-------: | :-------: |
| 后端服务 | 直接访问后端服务 | 23540| 32.19 | 27325| 52.09 |
| 流量网关 | kong <br/>v2.4.1 | 15662 | 50.87 | 17152 | 84.3 |
| 应用网关 | fizz-gateway-community <br/>v2.0.0 | 12206 | 65.76 | 12766 | 100.34 |
| 应用网关 | fizz-gateway-node <br/>v2.0.0 | 12206 | 65.76 | 12766 | 100.34 |
| 应用网关 | spring-cloud-gateway <br/>v2.2.9| 11323 | 68.57 | 10472 | 127.59 |
| 应用网关 | shenyu <br/>v2.3.0| 9284 | 92.98 | 9939 | 148.61 |
## 版本对照
- fizz-gateway-community 社区版
- fizz-gateway-node 节点端
- fizz-manager-professional管理后台专业版服务端
- fizz-admin-professional管理后台专业版前端
| fizz-gateway-community | fizz-manager-professional | fizz-admin-professional |
| fizz-gateway-node | fizz-manager-professional | fizz-admin-professional |
| ---------------------- | ------------------------- | ----------------------- |
| v1.0.0 | v1.0.0 | v1.0.0 |
| v1.1.0 | v1.1.0 | v1.1.0 |
@@ -98,11 +98,11 @@ API地址http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
从v1.3.0开始管理后台的前端和服务端合并成一个包
- fizz-gateway-community 社区版
- fizz-gateway-node 节点端
- fizz-manager-professional管理后台
| fizz-gateway-community | fizz-manager-professional |
| fizz-gateway-node | fizz-manager-professional |
|------------------------|---------------------------|
| v1.3.0 | v1.3.0 |
| v1.4.0 | v1.4.0 |
@@ -131,9 +131,10 @@ API地址http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
| v2.6.6 | v2.6.6 |
| v2.7.0 | v2.7.0 |
| v2.7.1 | v2.7.1 |
| v2.7.2 | v2.7.2 |
请根据社区版的版本下载对应的管理后台版本
请根据节点端的版本下载对应的管理后台版本
## 部署说明
@@ -172,7 +173,7 @@ API地址http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
安装方式二v2.0.0或以上版本docker:
SQL脚本下载页https://github.com/fizzgate/fizz-gateway-community/releases/tag/{version} (把{version}替换为对应版本号)
SQL脚本下载页https://github.com/fizzgate/fizz-gateway-node/releases/tag/{version} (把{version}替换为对应版本号)
首次安装执行`fizz-manager-professional-{version}-mysql.sql`数据库脚本从低版本升级至高版本选择执行update目录下对应升级脚本如有脚本则执行
@@ -201,7 +202,7 @@ docker run --rm -d -p 8000:8000 \
服务启动后访问 http://{部署机器IP地址}:8000/#/login,使用超级管理员账户`admin`密码`Aa123!`登录
#### 二、安装fizz-gateway-community社区版
#### 二、安装fizz-gateway-node节点端
说明:
@@ -211,7 +212,7 @@ docker run --rm -d -p 8000:8000 \
安装方式一:二进制安装包
1. 下载fizz-gateway-community的二进制安装包解压修改application.yml配置文件里配置中心、注册中心、redis(redis配置需与管理后台一致)的配置
1. 下载fizz-gateway-node的二进制安装包解压修改application.yml配置文件里配置中心、注册中心、redis(redis配置需与管理后台一致)的配置
2. 根据需要修改boot.sh脚本的apollo连接不使用apollo配置中心可跳过
3. Linux启动 执行 `./boot.sh start` 命令启动服务,支持 start/stop/restart/status命令
4. Windows启动 执行`.\boot.cmd start` 命令启动服务,支持 start/stop/restart/status命令
@@ -219,12 +220,12 @@ docker run --rm -d -p 8000:8000 \
安装方式二:源码安装:
1. 本地clone仓库上的最新代码修改application.yml配置文件里配置中心、注册中心、redis(redis配置需与管理后台一致)的配置
2. 在项目根目录fizz-gateway-community下执行Maven命令`mvn clean package install -DskipTests=true`
3. 在项目目录fizz-gateway-community/fizz-bootstrap下执行Maven命令`mvn clean package -DskipTests=true`
4. 进入fizz-gateway-community/fizz-bootstrap/target/fizz-gateway-community目录,执行 `./boot.sh start` 命令启动服务,支持 start/stop/restart/status命令
2. 在项目根目录fizz-gateway-node下执行Maven命令`mvn clean package install -DskipTests=true`
3. 在项目目录fizz-gateway-node/fizz-bootstrap下执行Maven命令`mvn clean package -DskipTests=true`
4. 进入fizz-gateway-node/fizz-bootstrap/target/fizz-gateway-node目录,执行 `./boot.sh start` 命令启动服务,支持 start/stop/restart/status命令
安装方式三v2.0.0或以上版本docker:
1. 下载对应版本的镜像docker pull fizzgate/fizz-gateway-community:{version}
1. 下载对应版本的镜像docker pull fizzgate/fizz-gateway-node:{version}
2. 通过环境变量方式修改redis配置其它配置同理并运行镜像
```sh
docker run --rm -d -p 8600:8600 \
@@ -232,16 +233,16 @@ docker run --rm -d -p 8600:8600 \
-e "aggregate.redis.port={your redis port}" \
-e "aggregate.redis.password={your redis password}" \
-e "aggregate.redis.database={your redis database}" \
fizzgate/fizz-gateway-community:{version}
fizzgate/fizz-gateway-node:{version}
```
或通过映射目录方式使用外部配置文件和输出日志到宿主机, 配置文件可从安装包或源码里获取在宿主机创建fizz-gateway-community/config和fizz-gateway-community/logs目录把application.yml和log4j2-spring.xml配置文件放置config下在fizz-gateway-community目录下运行镜像
或通过映射目录方式使用外部配置文件和输出日志到宿主机, 配置文件可从安装包或源码里获取在宿主机创建fizz-gateway-node/config和fizz-gateway-node/logs目录把application.yml和log4j2-spring.xml配置文件放置config下在fizz-gateway-node目录下运行镜像
```sh
cd fizz-gateway-community
cd fizz-gateway-node
docker run --rm -d -p 8600:8600 \
-v $PWD/config:/opt/fizz-gateway-community/config \
-v $PWD/logs:/opt/fizz-gateway-community/logs fizzgate/fizz-gateway-community:{version}
-v $PWD/config:/opt/fizz-gateway-node/config \
-v $PWD/logs:/opt/fizz-gateway-node/logs fizzgate/fizz-gateway-node:{version}
```
最后访问网关地址形式为http://127.0.0.1:8600/[服务名]/[API_Path]
@@ -298,28 +299,28 @@ FizzGate官方微信群请加入群之后再询问群主
## 授权说明
1. 网关核心项目fizz-gateway-community社区版本以GNU v3的方式进行的开放在遵循GNU协议的个人非商业化项目中可以免费使用
1. 网关核心项目fizz-gateway-node节点端本以GNU v3的方式进行的开放任何商业使用都需要经过我们授权
2. 管理后台项目(fizz-manager-professional)作为商业版本仅开放二进制包 [免费下载](https://wj.qq.com/s2/8682608/8fe2/)而商业项目请注明公司名称联系我们sale@fizzgate.com进行授权了解商业授权规则请点击[商业授权规则](https://github.com/fizzgate/fizz-gateway-community/wiki/%E5%95%86%E4%B8%9A%E6%8E%88%E6%9D%83)
2. 管理后台项目(fizz-manager-professional)作为商业版本仅开放二进制包 [免费下载](https://wj.qq.com/s2/8682608/8fe2/)而商业项目请注明公司名称联系我们sale@fizzgate.com进行授权了解商业授权规则请点击[商业授权规则](https://github.com/fizzgate/fizz-gateway-node/wiki/%E5%95%86%E4%B8%9A%E6%8E%88%E6%9D%83)
3. 在选择FizzGate之前我们强烈建议您先试用一下我们的DEMO站点试用我们的产品并且思考与自身的业务结合并且考虑产品推行落地方式在查阅我们的官网价格(https://www.fizzgate.com) 之后再进一步与我们联系。
## 系统截图
![homepage](https://user-images.githubusercontent.com/6129661/156333191-1b9901f5-e086-4514-84f0-4a74684fdf2d.png)
![homepage](https://cdn.fizzgate.com/fizz/assets/img/manager_source_statistics_1.991ec114.png)
![aggr1](https://user-images.githubusercontent.com/6129661/156333163-e2aade71-081c-49f0-9c7b-deb19239be84.png)
![aggr1](https://cdn.fizzgate.com/fizz/assets/img/manager_aggregate_add_2.72b385b5.png)
![aggr2](https://user-images.githubusercontent.com/6129661/156333175-770ac66d-0295-43b1-948a-a91d9a1922dd.png)
![aggr2](https://cdn.fizzgate.com/fizz/assets/img/manager_aggregate_add_9.662f119e.png)
![route](https://user-images.githubusercontent.com/6129661/156333194-9a4051a8-c59c-493f-8dd9-f004c364b8c4.png)
![route](https://cdn.fizzgate.com/fizz/assets/img/route1.1fd8abd1.png)
![plugin](https://user-images.githubusercontent.com/6129661/156333193-b0bdfae3-4660-42a0-93e3-118333c5b246.png)
![plugin](https://cdn.fizzgate.com/fizz/assets/img/manager_plugin_add_2.e1b5a24e.png)
![appid](https://user-images.githubusercontent.com/6129661/156333180-55d4167b-1eba-4fde-900d-6499f971b97f.png)
![appid](https://cdn.fizzgate.com/fizz/assets/img/manager_app_id_add_2.49208bf6.png)
![breaker](https://user-images.githubusercontent.com/6129661/156333182-40986e36-0f80-46b7-aced-1c16406ba2ce.png)
![breaker](https://cdn.fizzgate.com/fizz/assets/img/component2.7e77c716.png)
![flowcontrol](https://user-images.githubusercontent.com/6129661/156333189-0b209c2b-5026-4a6e-9880-9fc08ee72077.png)
![flowcontrol](https://cdn.fizzgate.com/fizz/assets/img/manager_flow_control_rule_default_edit_2.130223a7.png)
![doc](https://user-images.githubusercontent.com/6129661/156333188-6a2dae42-24b2-48c6-b401-1b6bbd9f6030.png)
![doc](https://cdn.fizzgate.com/fizz/assets/img/manager_interface_collection_preview_2.eee99e97.png)