BirdTouch WebAPI

BirdTouch-Webapi

BirdTouch-Webapiは、BirdTouch Androidアプリによって消費されるサーバーです。

サーバーは、postgreSQLデータベースを使用して.NET 5.0で記述されています。

要件

• Docker
• Dockerは作曲します
• ポート4050無料で、Dockerデーモンが実行されているマシン上のアプリでは使用していません

インストール

• configure .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_DEFAULT_PASSWORDパスワードPGADMINアプリへのアクセスに使用されるパスワードを更新します。
  • 承認トークンのハッシュに使用されるJWTSecurityKey変更します。

• オプション：

  • 非アクティブなユーザーがいるかどうかを確認するRemoveInactiveUsersRunEveryスケジュールされたタスク
  • RemoveInactiveUsersRemoveUsersOlderThan 、ユーザーが非アクティブな状態にあると考慮されているため、何時間の不活性が検討されているかを設定します

詳細を知っておくとよいでしょう

WSL2 LinuxコンテナのIPアドレスの取得

Windows10でWSL2を使用しており、DockerをインストールしたLinuxコンテナを使用している場合、BirdTouch WebAPI（Androidエミュレータで実行されているBirdTouchクライアントなど）にアクセスするために、WSL2セッションの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サイトは、動的なIPアドレスをいくつかのホスト名に同期するDUCツールを提供します。そのようにして、ローカルPCから何でもホストできます。