Format README variables as tables

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