BirdTouch WebAPI

Birdtouch-webapi

Birdtouch-Webapi est un serveur consommé par l'application Android BirdTouch.

Le serveur est écrit en .NET 5.0 à l'aide de la base de données PostgreSQL.

Exigences

• Docker
• Docker
• Port 4050 pour être gratuit et non utilisé par aucune application sur la machine où Docker Daemon fonctionne

Installation

• Configurer le fichier .env (voir la section de configuration)
• Exécuter docker-compose up -d à partir de la racine de ce repo
• Exécutez docker-compose ps pour vérifier si tous les services sont opérationnels
  • Remarque: le service database-migration doit être à Exit 0
• Félicitations! WebAPI (avec base de données) est désormais disponible sur le port 4050

Migration de base de données [Facultatif] (mise à niveau / nouveaux scripts SQL)

Tous les scripts SQL utilisés pour créer une base de données et pour insérer les données nécessaires se trouvent dans le dossier Migrations.

Afin d'ajouter de nouveaux scripts personnalisés ou d'exécuter une mise à niveau de la base de données, veuillez suivre la procédure suivante:

1. Créer un nouveau script .sql suivant la convention de dénomination dans le dossier Migrations - l'idée est que les scripts sont triés par ordre alphabétique afin d'avoir une sorte d'ordre d'exécution.

2. Notez que les scripts autrefois exécutés ne seront pas exécutés à nouveau sur la même base de données (pour vérifier si le script est exécuté, le nom du script est utilisé)

3. Lorsque vous avez tous les scripts nécessaires maintenant ajoutés au dossier Migrations, veuillez exécuter:

   docker-compose up database-migration --build

Configuration

Toute la configuration est effectuée en modifiant le fichier .env.

• Modifications recommandées:

  • Mettez à jour les chaînes POSTGRES_PASSWORD et les chaînes de connexion utilisées pour accéder à la base de données.
  • Mettez à jour le mot de passe PGADMIN_DEFAULT_PASSWORD utilisé pour accéder à l'application pgadmin.
  • Changer JWTSecurityKey qui est utilisé pour le hachage des jetons d'autorisation.

• Facultatif:

  • RemoveInactiveUsersRunEvery qui vérifiera s'il y a des utilisateurs inactifs
  • RemoveInactiveUsersRemoveUsersOlderThan définit le nombre d'heures d'inactivité considérées pour que l'utilisateur soit dans un état inactif

Bon à connaître les détails

Obtention de l'adresse IP du conteneur Linux WSL2

Si vous utilisez WSL2 sur Windows10 et que vous avez un conteneur Linux où vous avez installé Docker, afin d'accéder à BirdTouch Webapi (par exemple du client BirdTouch fonctionnant sur Android Emulat), vous devez découvrir l'adresse IP de la session WSL2.

Effectuez la procédure suivante:

1. Connectez-vous à Linux Machine avec WSL2
2. Exécuter ifconfig
3. Trouvez la valeur net de l' eth0: par exemple, ce serait 172.22.200.173
4. Félicitations, vous pouvez maintenant accéder à votre Birdtouch Webapi en cours d'exécution sur WSL2 Linux Container via 172.22.200.173:4050

Si vous souhaitez servir Webapi à partir de votre PC

1. Vérifiez si le port où WebAPI fonctionne (généralement 4050) est accessible au monde:
2. Sinon, configurez-le pour être! :)
3. [Facultatif] Le site NOIP.com fournit des outils DUC qui synchronisent votre adresse IP dynamique à un nom d'hôte, de cette façon, vous pouvez héberger n'importe quoi à partir de votre PC local et ne pas vous soucier du changement d'adresse IP