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地址更改