BirdTouch WebAPI

BirdTouch-Webapi

BirdTouch-Webapi-это сервер, который используется приложением BirdTouch Android.

Сервер записан в .net 5.0 с использованием базы данных PostgreSQL.

Требования

• Докер
• Docker Compose
• Порт 4050 чтобы быть бесплатным и не используется каким -либо приложением на машине, где работает Docker Daemon

Установка

• Настроить файл .env (см. Раздел конфигурации)
• Запустить docker-compose up -d от корня этого репо
• Запустите docker-compose ps чтобы проверить, работают ли все службы и запущены
  • Примечание. Служба database-migration должна быть на Exit 0
• Поздравляю! Webapi (с базой данных) теперь доступен в порту 4050

[Необязательно] Миграция базы данных (обновление/новые сценарии SQL)

Все сценарии SQL, используемые для создания базы данных и для вставки необходимых данных, расположены в папке Mygrations.

Чтобы добавить пользовательские новые сценарии или выполнить обновление базы данных, пожалуйста, следуйте следующей процедуре:

1. Создайте новый скрипт .SQL после соглашения об именах в папке миграции - идея заключается в том, что сценарии алфавитно отсортированы, чтобы иметь какой -то порядок выполнения.

2. Обратите внимание, что сценарии, которые когда -то выполняются, не будут выполняться снова в той же базе данных (чтобы проверить, выполняется ли сценарий, используется имя скрипта)

3. Когда у вас есть все необходимые сценарии, теперь добавленные в папку миграции, пожалуйста, выполните:

   docker-compose up database-migration --build

Конфигурация

Вся конфигурация выполняется путем редактирования .ENV -файла.

• Рекомендуемые изменения:

  • Обновите POSTGRES_PASSWORD и строки подключения, используемые для доступа к базе данных.
  • Обновление PGADMIN_DEFAULT_PASSWORD пароль, используемый для доступа к приложению Pgadmin.
  • Измените JWTSecurityKey , который используется для хэширования токенов авторизации.

• Необязательный:

  • RemoveInactiveUsersRunEvery Запланированную задачу, которая проверит, есть ли неактивные пользователи
  • RemoveInactiveUsersRemoveUsersOlderThan Установить, сколько часов неактивности рассматривается для пользователя, чтобы быть в неактивном состоянии

Хорошо знать подробности

Получение IP -адреса контейнера WSL2 Linux

Если вы используете WSL2 в Windows10 и имеете контейнер Linux, где вы установили Docker, чтобы получить доступ к BirdTouch WebAPI (например, от клиента BirdTouch, работающего на эмуляторе Android), вам необходимо выяснить IP -адрес сеанса WSL2.

Сделайте следующую процедуру:

1. Войдите в Minux Machine с WSL2
2. Выполнить ifconfig
3. Найдите net стоимость eth0: например, это будет 172.22.200.173
4. Поздравляем, теперь вы можете получить доступ к вашему Birdtouch Webapi, работающему на контейнере WSL2 Linux через 172.22.200.173:4050

Если вы хотите обслуживать Webapi от своего ПК

1. Проверьте, доступен ли порт, где работает WebAPI (обычно 4050) для всего мира:
2. Если нет, настройте это, чтобы быть! :)
3. [Необязательно] Сайт NOIP.com предоставляет инструменты DUC, которые синхронизируют ваш динамический IP -адрес с некоторым именем хоста, вы можете размещать что угодно из локального ПК и не беспокоиться об изменении IP -адреса