Add deployment/OpenCVE.md

deployment/OpenCVE.md

@@ -0,0 +1,78 @@
+# 🔽 OpenCVE — Plateforme open source de veille et d'alerte sur les vulnérabilités (CVE).
+
+>- Documentation officielle => https://docs.opencve.io/
+>- Dépot GitHub => https://github.com/opencve/opencve
+
+# Installation via le script officiel (stack docker)
+
+## 1. Prérequis
+- Docker v25 ou plus récent avec le plugin docker-compose
+- Cpu 4c avec 4Gb de ram
+- Minimum 30go d'espace disque disponible
+
+
+## 2. Cloner le repo opencve et aller dans le dossier `docker`
+```bash
+git clone https://github.com/opencve/opencve.git
+cd opencve/docker/
+```
+
+
+## 3. Initialiser les fichiers de configurations
+```bash
+# Docker compose  : ./.env
+# Webserver       : ../web/opencve/conf/.env
+# Airflow         : ../scheduler/airflow.cfg
+# Django          : ../web/opencve/conf/settings.py
+# Nginx           : ./conf/default.conf.template
+#                   ./conf/opencve.conf.template
+
+cp ./conf/.env.example ./.env
+cp ../web/opencve/conf/.env.example ../web/opencve/conf/.env
+cp ../scheduler/airflow.cfg.example ../scheduler/airflow.cfg
+cp ../web/opencve/conf/settings.py.example ../web/opencve/conf/settings.py
+cp ./conf/default.conf.template.example ./conf/default.conf.template
+cp ./conf/opencve.conf.template.example ./conf/opencve.conf.template
+
+```
+
+
+## 4. Modifier le .env du Docker compose
+```bash
+nano ./.env
+
+# Variables à adapter :
+# POSTGRES_PASSWORD
+# _AIRFLOW_WWW_USER_USERNAME
+# _AIRFLOW_WWW_USER_PASSWORD
+# AIRFLOW__CORE__FERNET_KEY
+```
+
+
+## 5. Executer le script d'installation
+```bash
+./install.sh start
+```
+
+
+## 6. Creation du superuser
+- Lors de l'installation il vous sera automatiquement invité à créer le superuser
+- S'il vous est nécessaire dans créer un plus tard `./install.sh create-superuser`
+
+
+## 7. Accès à l'interface Airflow
+- Aller sur l'adresse serveur sur le port 8080 `http://addr.ip.du.srv:8080`
+- Utilisateur = `Celui renseigné dans le .env`
+- Mot de passe = `Celui renseigné dans le .env`
+
+
+## 8. Accès à l'interface OpenCVE
+- Aller sur l'adresse serveur sur le port 80 `http://addr.ip.du.srv:80`
+- Utilisateur = `Celui créé lors de l'installation`
+- Mot de passe = `Celui créé lors de l'installation`
+- Lors de la première connexion un formulaire est à remplir, ex :
+  - Organisation = `Homelab`
+  - Project = `Homelab`
+  - Next, Next puis Finish
+
+