نصب

این فصل نحوهٔ نصب وابستگی‌ها، پیکربندی کلیدهای اختیاری API و اجرای پنل CVE Intelligence در محیط توسعه یا تولید را شرح می‌دهد. نصب موفق به معنای دسترسی به UI روی پورت ۵۱۷۳ (توسعه) یا ۳۰۰۱ (فایل‌های استاتیک تولید) است.

پیش از اسکن، اطمینان حاصل کنید که خروجی HTTPS به NVD، OSV، GitHub، CISA و میزبان‌های RSS از همان ماشینی که API اجرا می‌شود مجاز است.

پیش‌نیازها

به Node.js ۱۸+ و npm نیاز دارید. برای ساخت سایت مستندات جداگانه، Python ۳.۱۰+ در پوشهٔ extended-docs/ لازم است. خود اپلیکیشن پایگاه داده نمی‌خواهد؛ وضعیت در مرورگر و حافظهٔ سرور نگه داشته می‌شود.

کلون مخزن، دسترسی HTTPS خروجی به فیدها، و در صورت تمایل NVD_API_KEY و GITHUB_TOKEN برای سقف بالاتر نرخ درخواست از پیش‌نیازهای عملیاتی هستند.

• کلون مخزن 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 تنظیم کنید. در استقرار واقعی پشت reverse proxy با HTTPS قرار دهید؛ endpointهای اسکن و ترجمه را بدون احراز هویت در اینترنت عمومی در دسترس نگذارید.

سایت مستندات

مستندات گسترده (همین سایت):

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

مستندات کوتاه قدیمی: make docs-serve از ریشهٔ مخزن.

بررسی سلامت

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

انتظار "ok": true و آرایهٔ sources با شناسهٔ فیدهای پیکربندی‌شده.

بعدی: رابط کاربری