Skip to content

Installation

Ce chapitre explique comment installer les dépendances, configurer les clés API optionnelles et exécuter CVE Intelligence Panel en développement ou production. Une installation réussie affiche l'UI web sur le port 5173 (dev) ou 3001 (static production).

Prérequis

Il faut Node.js 18+ et npm. Pour construire le site de documentation séparément, Python 3.10+ est requis dans extended-docs/. L'application n'exige pas de base de données ; l'état est dans le navigateur et les caches mémoire serveur.

  • Clone Git du dépôt
  • HTTPS sortant vers NVD, OSV, GitHub, CISA et hôtes RSS
  • Optionnel : NVD_API_KEY, GITHUB_TOKEN pour des limites de débit plus élevées

Démarrage rapide (développement)

Depuis la racine du dépôt :

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

Ouvrez http://localhost:5173. Vite proxy /api vers le serveur API.

Premier lancement (v1.1.0+)

Les nouvelles installations voient d’abord un avertissement juridique, puis l’assistant de configuration (pile, alertes/veille, sources de données). À la fin, l’app ouvre le tableau de bord. Vous pouvez optionnellement lancer un premier scan complet depuis la dernière étape.

Les utilisateurs existants avec une pile déjà dans localStorage sont migrés automatiquement (setupComplete est défini sans relancer l’assistant). Les résultats de scan en cache se chargent depuis la session précédente si la pile correspond.

Production

make build
make start    # NODE_ENV=production — sert dist/ + API sur PORT (défaut 3001)

Définissez PORT dans .env si 3001 est occupé. En déploiement réel, placez l'app derrière un reverse proxy HTTPS ; n'exposez pas les endpoints de traduction ou de scan sur Internet public sans authentification.

Site de documentation

Documentation étendue (ce site) :

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

Docs legacy plus courtes : make docs-serve depuis la racine (docs/mkdocs.yml).

Vérifier la santé

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

Attendez "ok": true et un tableau sources listant les id de flux configurés.

Suite : Interface utilisateur