BirdTouch WebAPI

Birdtouch-Webapi

Birdtouch-Webapi ist ein Server, der von der Birdtouch Android App verzehrt wird.

Der Server wird in .NET 5.0 mit der PostgreSQL -Datenbank geschrieben.

Anforderungen

• Docker
• Docker komponieren
• Port 4050 um kostenlos zu sein und von einer App auf dem Computer, auf dem Docker -Daemon ausgeführt wird

Installation

• Konfigurieren Sie .env -Datei (siehe Abschnitt Konfiguration)
• Führen Sie docker-compose up -d aus der Wurzel dieses Repos aus
• Führen Sie docker-compose ps aus, um zu überprüfen, ob alle Dienste in Betrieb sind
  • HINWEIS: database-migration -Service sollte in der staatlichen Exit 0 sein
• Glückwunsch! Webapi (mit Datenbank) ist jetzt auf Port 4050 verfügbar

[Optionale] Datenbankmigration (Upgrade/neue SQL -Skripte)

Alle SQL -Skripte, die zum Erstellen von Datenbank und zum Einfügen der erforderlichen Daten verwendet werden, befinden sich im Migrationsordner.

Um benutzerdefinierte neue Skripte hinzuzufügen oder Datenbank -Upgrade durchzuführen, befolgen Sie die folgende Prozedur:

1. Erstellen Sie ein neues .sql -Skript nach der Namenskonvention im Ordner Migrations - Idee ist, dass Skripte alphabetisch sortiert sind, um eine Art Ausführung zu haben.

2. Beachten Sie, dass Skripte, die nach dem Ausführen von Skripten werden, nicht erneut in derselben Datenbank ausgeführt werden (um zu überprüfen, ob das Skript ausgeführt wird, wird der Skriptname verwendet).

3. Wenn Sie alle erforderlichen Skripte zum Migrationsordner hinzugefügt haben, führen Sie bitte aus:

   docker-compose up database-migration --build

Konfiguration

Die gesamte Konfiguration erfolgt durch Bearbeiten .env -Datei.

• Empfohlene Änderungen:

  • Aktualisieren Sie POSTGRES_PASSWORD und Verbindungszeichenfolgen, die zum Zugriff auf die Datenbank verwendet werden.
  • Aktualisieren Sie PGADMIN_DEFAULT_PASSWORD -Kennwort, das zum Zugriff auf PGADMIN -App verwendet wird.
  • Ändern Sie JWTSecurityKey , der zum Hashing der Autorisierungs -Token verwendet wird.

• Optional:

  • Die geplante Aufgabe RemoveInactiveUsersRunEvery , die prüft, ob es inaktive Benutzer gibt
  • RemoveInactiveUsersRemoveUsersOlderThan setzen, wie viele Stunden Inaktivität für den Benutzer als inaktives Zustand in Betracht gezogen werden

Gut, Einzelheiten zu kennen

IP -Adresse des WSL2 -Linux -Containers erhalten

Wenn Sie WSL2 unter Windows10 verwenden und einen Linux -Container haben, in dem Sie Docker installiert haben, müssen Sie die IP -Adresse der WSL2 -Sitzung herausfinden, um auf Birdtouch Webapi (z.

Führen Sie das folgende Verfahren durch:

1. Melden Sie sich bei der Linux -Maschine mit WSL2 an
2. Führen Sie ifconfig aus
3. Finden Sie den net des eth0: Zum Beispiel wäre es 172.22.200.173
4. Herzlichen Glückwunsch, jetzt können Sie auf Ihr Birdtouch -Webapi auf WSL2 Linux Container über 172.22.200.173:4050 zugreifen

Wenn Sie Webapi von Ihrem PC servieren möchten

1. Überprüfen Sie, ob Port, wo Webapi funktioniert (normalerweise 4050), für die Welt zugänglich:
2. Wenn nicht, konfigurieren Sie es so! :)
3. [Optional] NOIP.com -Site bietet Duc -Tools, die Ihre dynamische IP -Adresse mit einem Hostnamen synchronisieren. Auf diese Weise können Sie alles von Ihrem lokalen PC hosten und sich keine Sorgen um die IP -Adresse ändern