From f440a8e49757cc0e3cf925c631a414897ff94e32 Mon Sep 17 00:00:00 2001 From: Olivier Date: Wed, 13 May 2026 17:25:22 +0200 Subject: [PATCH] Format README variables as tables --- README.fr.md | 22 ++++++++++++---------- README.md | 22 ++++++++++++---------- 2 files changed, 24 insertions(+), 20 deletions(-) diff --git a/README.fr.md b/README.fr.md index da6d9c0..fad1207 100644 --- a/README.fr.md +++ b/README.fr.md @@ -196,16 +196,18 @@ L'utilisateur qui exécute la crontab doit avoir le droit de lire `.env` et d'é ## 🔧 Variables utiles -- 🌐 `PVE_API_URL` : URL d'un noeud PVE joignable, par exemple `https://pve.example.invalid:8006`. -- 🔑 `PVE_API_TOKEN_ID` : identifiant complet du token, par exemple `backup-report@pve!report`. -- 🔒 `PVE_API_TOKEN_SECRET` : secret du token. -- 🌍 `REPORT_LANGUAGE` : langue du rapport PDF, `fr` ou `en`. Défaut : `fr`. -- 🛡️ `PVE_VERIFY_TLS` : laisser `true` en production ; utiliser `PVE_CA_BUNDLE` pour une CA interne. -- 🕒 `PVE_TASK_HISTORY_LIMIT` : nombre de tâches PVE récentes inspectées pour retrouver la dernière sauvegarde. -- 📜 `PVE_TASK_LOG_LIMIT` : nombre de lignes récupérées par log `vzdump` pour extraire le détail par VM/CT. -- 🗺️ `PBS_HOSTNAMES` : mapping manuel optionnel des serveurs PBS sous la forme `adresse=nom-affiche,adresse2=nom-affiche2`. -- 🗄️ `PBS_*` : configurations optionnelles des API PBS, par exemple `PBS01_*`, `PBS02_*`, `PBS10_*`. -- 🏷️ `REPORT_FILENAME_PREFIX` : préfixe du fichier PDF généré. +| Variable | Description | +| --- | --- | +| `PVE_API_URL` | URL d'un noeud PVE joignable, par exemple `https://pve.example.invalid:8006`. | +| `PVE_API_TOKEN_ID` | Identifiant complet du token, par exemple `backup-report@pve!report`. | +| `PVE_API_TOKEN_SECRET` | Secret du token. | +| `REPORT_LANGUAGE` | Langue du rapport PDF, `fr` ou `en`. Défaut : `fr`. | +| `PVE_VERIFY_TLS` | Laisser `true` en production ; utiliser `PVE_CA_BUNDLE` pour une CA interne. | +| `PVE_TASK_HISTORY_LIMIT` | Nombre de tâches PVE récentes inspectées pour retrouver la dernière sauvegarde. | +| `PVE_TASK_LOG_LIMIT` | Nombre de lignes récupérées par log `vzdump` pour extraire le détail par VM/CT. | +| `PBS_HOSTNAMES` | Mapping manuel optionnel des serveurs PBS sous la forme `adresse=nom-affiche,adresse2=nom-affiche2`. | +| `PBS_*` | Configurations optionnelles des API PBS, par exemple `PBS01_*`, `PBS02_*`, `PBS10_*`. | +| `REPORT_FILENAME_PREFIX` | Préfixe du fichier PDF généré. | ## 📄 Sortie PDF diff --git a/README.md b/README.md index 973cefd..18f9b51 100644 --- a/README.md +++ b/README.md @@ -193,16 +193,18 @@ The user running the crontab must have read access to `.env` and write access to ## 🔧 Key variables -- 🌐 `PVE_API_URL`: URL of a reachable PVE node, e.g. `https://pve.example.invalid:8006`. -- 🔑 `PVE_API_TOKEN_ID`: full token identifier, e.g. `backup-report@pve!report`. -- 🔒 `PVE_API_TOKEN_SECRET`: token secret. -- 🌍 `REPORT_LANGUAGE`: PDF report language, `fr` or `en`. Default: `fr`. -- 🛡️ `PVE_VERIFY_TLS`: keep `true` in production; use `PVE_CA_BUNDLE` for an internal CA. -- 🕒 `PVE_TASK_HISTORY_LIMIT`: number of recent PVE tasks inspected to find the latest backup. -- 📜 `PVE_TASK_LOG_LIMIT`: number of lines retrieved per `vzdump` log to extract per-VM/CT detail. -- 🗺️ `PBS_HOSTNAMES`: optional manual mapping of PBS servers as `address=display-name,address2=display-name2`. -- 🗄️ `PBS_*`: optional PBS API configurations, e.g. `PBS01_*`, `PBS02_*`, `PBS10_*`. -- 🏷️ `REPORT_FILENAME_PREFIX`: prefix for the generated PDF filename. +| Variable | Description | +| --- | --- | +| `PVE_API_URL` | URL of a reachable PVE node, e.g. `https://pve.example.invalid:8006`. | +| `PVE_API_TOKEN_ID` | Full token identifier, e.g. `backup-report@pve!report`. | +| `PVE_API_TOKEN_SECRET` | Token secret. | +| `REPORT_LANGUAGE` | PDF report language, `fr` or `en`. Default: `fr`. | +| `PVE_VERIFY_TLS` | Keep `true` in production; use `PVE_CA_BUNDLE` for an internal CA. | +| `PVE_TASK_HISTORY_LIMIT` | Number of recent PVE tasks inspected to find the latest backup. | +| `PVE_TASK_LOG_LIMIT` | Number of lines retrieved per `vzdump` log to extract per-VM/CT detail. | +| `PBS_HOSTNAMES` | Optional manual mapping of PBS servers as `address=display-name,address2=display-name2`. | +| `PBS_*` | Optional PBS API configurations, e.g. `PBS01_*`, `PBS02_*`, `PBS10_*`. | +| `REPORT_FILENAME_PREFIX` | Prefix for the generated PDF filename. | ## 📄 PDF output