TarsGateway 项目安装与使用教程

TarsGateway 项目安装与使用教程

1. 项目的目录结构及介绍

TarsGateway 项目的目录结构如下：

TarsGateway/
├── github/workflows/
├── a1_HttpWupClient/
├── a3_script/
├── conf/
├── doc/
├── dockerfile/
├── images/
├── install/
├── scripts/
├── src/
├── test/
├── web/
├── yaml/
├── .gitignore
├── CMakeLists.txt
├── Changelist.md
├── LICENSE
├── README.en.md
├── README.md
└── logo.png

目录结构介绍

• github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• a1_HttpWupClient/: 存放与 HTTP WUP 客户端相关的代码和配置。
• a3_script/: 存放一些脚本文件。
• conf/: 存放项目的配置文件。
• doc/: 存放项目的文档文件。
• dockerfile/: 存放 Docker 相关的配置文件。
• images/: 存放项目的图片资源。
• install/: 存放安装相关的脚本和配置。
• scripts/: 存放一些辅助脚本。
• src/: 存放项目的源代码。
• test/: 存放测试相关的代码和配置。
• web/: 存放 Web 相关的代码和配置。
• yaml/: 存放 YAML 格式的配置文件。
• .gitignore: Git 忽略文件配置。
• CMakeLists.txt: CMake 构建配置文件。
• Changelist.md: 项目变更记录。
• LICENSE: 项目许可证文件。
• README.en.md: 英文版的项目介绍文档。
• README.md: 中文版的项目介绍文档。
• logo.png: 项目的 Logo 图片。

2. 项目的启动文件介绍

TarsGateway 项目的启动文件主要位于 src/ 目录下。具体来说，Base/GatewayServer 和 Base/GatewayWebServer 是两个主要的启动服务。

Base/GatewayServer

Base/GatewayServer 是实际的网关服务，负责处理 HTTP 请求并将其转发到后端服务。启动该服务时，会读取 conf/ 目录下的配置文件，并根据配置进行初始化。

Base/GatewayWebServer

Base/GatewayWebServer 是网关的管理平台，负责管理网关的路由信息和其他配置。启动该服务时，会自动创建相关的数据库表，并读取 config.json 配置文件。

3. 项目的配置文件介绍

TarsGateway 项目的配置文件主要位于 conf/ 目录下，主要包括以下几个文件：

GatewayServer.conf

GatewayServer.conf 是 Base/GatewayServer 的配置文件，主要包含以下配置项：

• mysql: MySQL 数据库的连接信息。
• http: HTTP 服务的配置信息，包括端口、路由等。
• log: 日志相关的配置信息。

config.json

config.json 是 Base/GatewayWebServer 的配置文件，主要包含以下配置项：

• mysql: MySQL 数据库的连接信息。
• web: Web 服务的配置信息，包括端口、路由等。
• log: 日志相关的配置信息。

数据库配置

在安装 TarsGateway 系统时，需要依赖 MySQL 数据库。因此，在安装时需要注意配置依赖的 MySQL 地址。GatewayServer 和 GatewayWebServer 的配置文件中都需要配置 MySQL 的连接信息。

数据库的配置文件通常位于 conf/ 目录下，具体文件名可能因版本不同而有所变化。

---

以上是 TarsGateway 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你顺利安装和使用 TarsGateway 项目。