Skip to content

التثبيت

يشرح هذا الفصل كيفية تثبيت الاعتماديات، ضبط مفاتيح API الاختيارية، وتشغيل لوحة CVE Intelligence في التطوير أو الإنتاج. ينتهي التثبيت الناجح بواجهة ويب على المنفذ 5173 (تطوير) أو 3001 (إنتاج ثابت).

قبل أول فحص، تأكد أن الخادم الذي يشغّل Express يستطيع إجراء HTTPS صادراً إلى NVD وOSV وGitHub وCISA ومضيفي RSS.

المتطلبات المسبقة

تحتاج Node.js 18+ وnpm. لبناء موقع التوثيق منفصلاً، يلزم Python 3.10+ في extended-docs/. التطبيق لا يحتاج قاعدة بيانات؛ الحالة في المتصفح وذاكرة مؤقتة على الخادم.

  • استنساخ المستودع عبر Git
  • HTTPS صادر إلى NVD وOSV وGitHub وCISA وRSS
  • اختياري: NVD_API_KEY، GITHUB_TOKEN لحدود معدل أعلى

البدء السريع (تطوير)

من جذر المستودع:

make setup    # npm install + .env من .env.example
make dev      # Vite :5173 + Express :3001

افتح http://localhost:5173. يوجّه Vite طلبات /api إلى خادم API.

الإطلاق الأول (v1.1.0+)

ترى التثبيتات الجديدة إخلاء مسؤولية قانونياً، ثم معالج الإعداد (المكدس، إعدادات التنبيه/المراقبة، مصادر البيانات). عند الانتهاء يفتح التطبيق لوحة التحكم. يمكنك اختيارياً تشغيل فحص كامل أولي من الخطوة الأخيرة.

يُرحَّل المستخدمون الحاليون الذين لديهم مكدس في localStorage تلقائياً (setupComplete يُضبط دون إعادة المعالج). تُحمَّل نتائج الفحص المخزّنة من الجلسة السابقة عندما يطابق المكدس.

الإنتاج

make build
make start    # NODE_ENV=production — يقدّم dist/ + API على PORT (افتراضي 3001)

اضبط PORT في .env إن كان 3001 مشغولاً. في الاستقرار الحقيقي ضع التطبيق خلف reverse proxy بـ HTTPS؛ لا تعرّض نقاط الفحص أو الترجمة للإنترنت العام دون مصادقة.

موقع التوثيق

التوثيق الموسّع (هذا الموقع):

cd extended-docs && make install && make serve

التوثيق القصير القديم: make docs-serve من جذر المستودع (docs/mkdocs.yml).

التحقق من الصحة

curl -s http://localhost:3001/api/health | jq .

توقّع "ok": true ومصفوفة sources تسرد معرّفات الخلاصات المضبوطة.

التالي: الواجهة