diff --git a/README.fr.md b/README.fr.md index 29cd7fb..b7a5e7f 100644 --- a/README.fr.md +++ b/README.fr.md @@ -4,6 +4,7 @@ ![Python](https://img.shields.io/badge/python-3.11%2B-green) ![License](https://img.shields.io/badge/license-Apache--2.0-orange) ![Docker](https://img.shields.io/badge/docker-ready-2496ED) +![Sécurité](https://img.shields.io/badge/s%C3%A9curit%C3%A9-sans_%C3%A9criture_PVE%2FPBS-brightgreen) Outil Python pour générer un rapport quotidien des sauvegardes Proxmox VE vers Proxmox Backup Server. @@ -22,6 +23,15 @@ L'application collecte les données via les API PVE/PBS, calcule la couverture d - ⚠️ Section d'anomalies pour les erreurs ou données de collecte partielles. - 🐳 Exécution recommandée avec Docker, ou exécution directe en CLI. +## 🔐 Prérequis + +Créer des utilisateurs ou tokens API dédiés à cette application de rapport. Ils doivent être limités aux droits d'audit/lecture seule : + +- Proxmox VE : attribuer uniquement le rôle `PVEAuditor` à l'utilisateur ou au token API utilisé par `PVE_API_TOKEN_ID`. +- Proxmox Backup Server : attribuer uniquement le rôle `Audit` à l'utilisateur ou au token API utilisé par chaque `PBS_API_TOKEN_ID`. + +Ne pas utiliser de compte administrateur ou de compte avec droits d'écriture. L'application a seulement besoin de lire l'inventaire, les jobs de sauvegarde, les tâches, les datastores, les namespaces, les snapshots et les données de rétention. + ## 🐳 Utilisation avec Docker Docker est le mode d'exécution recommandé. L'image contient les dépendances Python et les bibliothèques système nécessaires à WeasyPrint. diff --git a/README.md b/README.md index 8db2c05..991f333 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ ![Python](https://img.shields.io/badge/python-3.11%2B-green) ![License](https://img.shields.io/badge/license-Apache--2.0-orange) ![Docker](https://img.shields.io/badge/docker-ready-2496ED) +![Security](https://img.shields.io/badge/security-no_PVE%2FPBS_writes-brightgreen) Python tool to generate a daily backup report for Proxmox VE against Proxmox Backup Server. @@ -19,6 +20,15 @@ The application collects data via the PVE/PBS APIs, computes VM/CT coverage, ret - ⚠️ Anomalies section for errors or partial collection data. - 🐳 Recommended execution with Docker, or direct CLI execution. +## 🔐 Prerequisites + +Create dedicated API users or tokens for this reporting application. They must be limited to audit/read-only permissions: + +- Proxmox VE: assign only the `PVEAuditor` role to the user or API token used by `PVE_API_TOKEN_ID`. +- Proxmox Backup Server: assign only the `Audit` role to the user or API token used by each `PBS_API_TOKEN_ID`. + +Do not use administrator or write-enabled accounts. The application only needs to read inventory, backup jobs, tasks, datastores, namespaces, snapshots and retention data. + ## 🐳 Usage with Docker Docker is the recommended execution mode. The image includes the Python dependencies and system libraries required by WeasyPrint.