Update README.en-us.md
This commit is contained in:
Lin Yuying
@@ -5,14 +5,14 @@ English | [简体中文](./README.md)
|
||||
</p>
|
||||
<p>
|
||||
<img alt="Version" src="https://img.shields.io/badge/version-2.7.2-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>
|
||||
|
||||
@@ -74,20 +74,20 @@ We compare FzzGate with the major gateway products on the market, using the same
|
||||
| :------------------ | :------------------ | :-------: | :-------: | :-------: | :-------: |
|
||||
| Backend Service | direct access | 23540| 32.19 | 27325| 52.09 |
|
||||
| Traffic Gateway | kong <br/>v2.4.1 | 15662 | 50.87 | 17152 | 84.3 |
|
||||
| Application Gateway | fizz-gateway-community <br/>v2.0.0 | 12206 | 65.76 | 12766 | 100.34 |
|
||||
| Application Gateway | fizz-gateway-node <br/>v2.0.0 | 12206 | 65.76 | 12766 | 100.34 |
|
||||
| Application Gateway | spring-cloud-gateway <br/>v2.2.9 | 11323 | 68.57 | 10472 | 127.59 |
|
||||
| Application Gateway | shenyu <br/>v2.3.0 | 9284 | 92.98 | 9939 | 148.61 |
|
||||
|
||||
|
||||
## Version comparison
|
||||
|
||||
- fizz-gateway-community： Community Edition
|
||||
- fizz-gateway-node： Community Edition
|
||||
|
||||
- fizz-manager-professional：Management backend professional version (backend)
|
||||
|
||||
- fizz-admin-professional：Management backend professional version (frontend)
|
||||
|
||||
| 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 |
|
||||
@@ -96,11 +96,11 @@ We compare FzzGate with the major gateway products on the market, using the same
|
||||
|
||||
Starting from v1.3.0, the frontend and backend of the management backend are merged into one package
|
||||
|
||||
- fizz-gateway-community： Community Edition
|
||||
- fizz-gateway-node： Community Edition
|
||||
|
||||
- fizz-manager-professional：Management backend professional version
|
||||
|
||||
| fizz-gateway-community | fizz-manager-professional |
|
||||
| fizz-gateway-node | fizz-manager-professional |
|
||||
|------------------------|---------------------------|
|
||||
| v1.3.0 | v1.3.0 |
|
||||
| ... | ... |
|
||||
@@ -149,7 +149,7 @@ installation method 1: binary package:
|
||||
|
||||
Installation method 2: docker:
|
||||
|
||||
Download SQL script from page: https://github.com/fizzgate/fizz-gateway-community/releases/tag/{version} （replace {version} with corresponding version number）
|
||||
Download SQL script from page: https://github.com/fizzgate/fizz-gateway-node/releases/tag/{version} （replace {version} with corresponding version number）
|
||||
|
||||
For the first installation, execute the `fizz-manager-professional-{version}-mysql.sql` database script, upgrade from a low version to a high version, and choose to execute the corresponding upgrade script in the update directory
|
||||
|
||||
@@ -178,7 +178,7 @@ docker run --rm -d -p 8000:8000 \
|
||||
|
||||
After the service is started, visit http://{deployment machine IP address}:8000/#/login, and log in with the super administrator account `admin` password `Aa123!`
|
||||
|
||||
#### 二、Install fizz-gateway-community community edition
|
||||
#### 二、Install fizz-gateway-node community edition
|
||||
|
||||
Description:
|
||||
|
||||
@@ -188,7 +188,7 @@ Description:
|
||||
|
||||
Installation method 1: binary package:
|
||||
|
||||
1. Download the latest binary package of fizz-gateway-community and upzip to a directory, modify the configuration of the configuration center, registry, and redis in the application.yml configuration file (redis configuration needs to be consistent with the management backend).
|
||||
1. Download the latest binary package of fizz-gateway-node and upzip to a directory, modify the configuration of the configuration center, registry, and redis in the application.yml configuration file (redis configuration needs to be consistent with the management backend).
|
||||
2. Modify the apollo connection and JVM memory configuration of the boot.sh script
|
||||
3. Linux startup Execute `./boot.sh start` command to start the service, support start/stop/restart/status command
|
||||
4. Windows startup Execute `.\boot.cmd start` command to start the service, support start/stop/restart/status command
|
||||
@@ -196,13 +196,13 @@ Installation method 1: binary package:
|
||||
Installation method 2: source code:
|
||||
|
||||
1. The latest code on the local clone warehouse, modify the configuration of the configuration center, registry, and redis in the application.yml configuration file (redis configuration needs to be consistent with the management backend)
|
||||
2. Execute the Maven command `mvn clean package install -DskipTests=true` package in the project root directory fizz-gateway-community
|
||||
3. Execute the Maven command `mvn clean package -DskipTests=true` package in the project directory fizz-gateway-community/fizz-bootstrap
|
||||
4. Enter fizz-gateway-community/fizz-bootstrap/target/fizz-gateway-community directory and Execute `./boot.sh start` command to start the service, support start/stop/restart/status command
|
||||
2. Execute the Maven command `mvn clean package install -DskipTests=true` package in the project root directory fizz-gateway-node
|
||||
3. Execute the Maven command `mvn clean package -DskipTests=true` package in the project directory fizz-gateway-node/fizz-bootstrap
|
||||
4. Enter fizz-gateway-node/fizz-bootstrap/target/fizz-gateway-node directory and Execute `./boot.sh start` command to start the service, support start/stop/restart/status command
|
||||
|
||||
Installation method 3: docker:
|
||||
|
||||
1. Download docker image：docker pull fizzgate/fizz-gateway-community:{version}
|
||||
1. Download docker image：docker pull fizzgate/fizz-gateway-node:{version}
|
||||
2. Modify Redis configuration by env parameters and run with below docker command
|
||||
```sh
|
||||
docker run --rm -d -p 8600:8600 \
|
||||
@@ -210,16 +210,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}
|
||||
```
|
||||
|
||||
or using external configuration file and output log to host server by mount volume, configuration file could be achieved from source code or binary package, create fizz-gateway-community/config and fizz-gateway-community/logs directories in host server, place application.yml and log4j2-spring.xml configuration files to config folder, run with below docker command in fizz-gateway-community folder:
|
||||
or using external configuration file and output log to host server by mount volume, configuration file could be achieved from source code or binary package, create fizz-gateway-node/config and fizz-gateway-node/logs directories in host server, place application.yml and log4j2-spring.xml configuration files to config folder, run with below docker command in fizz-gateway-node folder:
|
||||
|
||||
```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}
|
||||
```
|
||||
|
||||
Finally visit the gateway, the address format is: http://127.0.0.1:8600/[Service name]/[API Path]
|
||||
@@ -272,26 +272,27 @@ FizzGate官方技术交流③群：512164278
|
||||
|
||||
## Authorization instructions
|
||||
|
||||
1. The fizz-gateway-community community version of the gateway core project is opened in the form of GNU V3 and can be used free of charge in non-commercial projects following the GNU protocol.
|
||||
1. The fizz-gateway-node community version of the gateway core project is opened in the form of GNU V3 and can be used free of charge in non-commercial projects following the GNU protocol.
|
||||
|
||||
2. Management backend projects (fizz-manager-professional) as commercial versions only open binary packages [free download](https://wj.qq.com/s2/8682608/8fe2/), and For commercial projects, please contact us (sale@fizzgate.com) for authorization.
|
||||
|
||||
## System screenshot
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user