BirdTouch WebAPI

BirdTouch-Webapi

BirdTouch-Webapi是由BirdTouch Android应用消费的服务器。

服务器使用PostgreSQL数据库以.NET 5.0编写。

要求

• Docker
• Docker组成
• 端口4050是免费的，并且在Docker守护程序正在运行的机器上没有使用任何应用程序

安装

• 配置.env文件（请参阅配置部分）
• 从此存储库的根部运行docker-compose up -d
• 运行docker-compose ps以检查所有服务是否启动并运行
  • 注意： database-migration服务应在州Exit 0
• 恭喜！ WebAPI（带有数据库）现在可以在端口4050上找到

[可选]数据库迁移（升级/新的SQL脚本）

所有用于创建数据库并插入必要数据的SQL脚本都位于迁移文件夹中。

为了添加自定义新脚本或执行数据库升级，请按照以下过程：

1. 在“迁移文件夹”中的命名约定之后创建新的.sql脚本 - 想法是按字母顺序排序脚本，以便具有某种执行顺序。

2. 请注意，曾经执行的脚本将不会在同一数据库上再次执行（要检查脚本是否执行，使用脚本名称）

3. 现在，当您将所有必要的脚本添加到迁移文件夹中时，请执行：

   docker-compose up database-migration --build

配置

所有配置都是通过编辑.ENV文件完成的。

• 建议的更改：

  • 更新用于访问数据库的POSTGRES_PASSWORD和连接字符串。
  • 更新用于访问PGADMIN应用程序的PGADMIN_DEFAULT_PASSWORD密码。
  • 更改用于哈希授权令牌的JWTSecurityKey 。

• 选修的：

  • RemoveInactiveUsersRunEvery计划的任务，该任务将检查是否存在非活动用户
  • RemoveInactiveUsersRemoveUsersOlderThan设置了数小时的无活动性，以使用户处于不活动状态

很高兴知道细节

获取WSL2 Linux容器的IP地址

如果您在Windows10上使用WSL2并在安装Docker的Linux容器上使用Linux容器，以访问BirdTouch webapi（例如，从Android Emulator上运行的BirdTouch客户端），您需要找到WSL2 Session的IP地址。

执行以下过程：

1. 使用WSL2登录到Linux机器
2. 执行ifconfig
3. 找到ETH0的net eth0:例如，它将是172.22.200.173
4. 恭喜，现在您可以通过172.22.200.173:4050访问在WSL2 Linux容器上运行的BirdTouch WebApi

如果您想从PC上服务WebAPI

1. 检查世界上是否可以使用WebAPI的端口（通常为4050）：
2. 如果没有，将其配置为！ :)
3. [可选] NOIP.com网站提供DUC工具，将您的动态IP地址同步到某些主机名，这样，您可以从本地PC中托管任何内容，而不必担心IP地址更改