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 المستخدمة لإنشاء قاعدة بيانات وإدراج البيانات اللازمة موجودة في مجلد الترحيل.

لإضافة البرامج النصية الجديدة المخصصة أو تنفيذ ترقية قاعدة البيانات ، يرجى اتباع الإجراء التالي:

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 Emulator) ، تحتاج إلى اكتشاف عنوان IP الخاص بجلسة WSL2.

هل الإجراء التالي:

1. تسجيل الدخول إلى جهاز Linux مع 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