BirdTouch WebAPI

Birdtouch-webapi

BirdTouch-Webapi는 BirdTouch Android 앱에서 소비하는 서버입니다.

Server는 PostgreSQL 데이터베이스를 사용하여 .NET 5.0으로 작성됩니다.

요구 사항

• 도커
• Docker Compose
• 포트 4050 무료로 제공되며 Docker Daemon이 실행중인 기계의 앱에서 사용하지 않습니다.

설치

• .env 파일 구성 (구성 섹션 참조)
• 이 repo의 루트에서 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 컨테이너가있는 경우 BirdTouch WebApi (예 : Android Emulator에서 실행되는 BirdTouch 클라이언트의)에 액세스하려면 WSL2 세션의 IP 주소를 찾아야합니다.

다음 절차를 수행하십시오.

1. WSL2를 사용하여 Linux Machine에 로그인하십시오
2. ifconfig 실행하십시오
3. eth0: 의 net 값을 찾으십시오. 예를 들어 172.22.200.173 입니다.
4. 축하합니다. 이제 172.22.200.173:4050 통해 WSL2 Linux 컨테이너에서 실행되는 BirdTouch 웹에 액세스 할 수 있습니다.

PC에서 Webapi를 제공하려면

1. WebApi가 작동하는 포트 (일반적으로 4050)가 전 세계에 액세스 할 수 있는지 확인하십시오.
2. 그렇지 않다면 구성하십시오! :)
3. [선택 사항] noip.com 사이트는 동적 IP 주소를 일부 호스트 이름과 동기화하는 DUC 도구를 제공합니다. 이렇게하면 로컬 PC에서 모든 것을 호스팅 할 수 있으며 IP 주소 변경에 대해 걱정하지 않습니다.