olivier/PVE-Backup-Report
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add email delivery check command

Browse Source
This commit is contained in:
Olivier
2026-05-20 15:29:19 +02:00
parent 6bdddc3d54
commit 86f7c0589c
8 changed files with 157 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/exploitation.md
+10
View File
@@ -45,6 +45,14 @@ This command tests `/nodes`, `/storage`, `/cluster` and the endpoint configured
If `/cluster/backup` returns `HTTP 403 - Permission check failed (/, Sys.Audit)`, the token works but lacks the `Sys.Audit` privilege on `/`.
### Email Delivery Test
```sh
docker compose run --rm pve-backup-report --check-email
```
This command sends a test email with the SMTP configuration from `.env`, without generating a PDF. It requires `REPORT_EMAIL_ENABLED=true` and returns an error if the SMTP connection, STARTTLS, authentication or sending fails.
### PDF Report Generation
```sh
@@ -124,6 +132,7 @@ Installed commands:
```sh
pve-backup-report --check-config
pve-backup-report --check-api
pve-backup-report --check-email
pve-backup-report --dump-inventory
pve-backup-report --dump-coverage
pve-backup-report --dump-report-data
@@ -137,6 +146,7 @@ Without editable installation:
```sh
PYTHONPATH=src python3 -m pve_backup_report --check-config
PYTHONPATH=src python3 -m pve_backup_report --check-api
PYTHONPATH=src python3 -m pve_backup_report --check-email
PYTHONPATH=src python3 -m pve_backup_report --dump-inventory
PYTHONPATH=src python3 -m pve_backup_report --dump-coverage
PYTHONPATH=src python3 -m pve_backup_report --dump-report-data
docs/fr/exploitation.md
+10
View File
@@ -45,6 +45,14 @@ Cette commande teste `/nodes`, `/storage`, `/cluster` et l'endpoint configure da
Si `/cluster/backup` retourne `HTTP 403 - Permission check failed (/, Sys.Audit)`, le token fonctionne mais il lui manque le privilege `Sys.Audit` sur `/`.
### Test d'envoi email
```sh
docker compose run --rm pve-backup-report --check-email
```
Cette commande envoie un email de test avec la configuration SMTP du fichier `.env`, sans generer de PDF. Elle exige `REPORT_EMAIL_ENABLED=true` et retourne une erreur si la connexion SMTP, STARTTLS, l'authentification ou l'envoi echoue.
### Generation du rapport PDF
```sh
@@ -124,6 +132,7 @@ Commandes installees :
```sh
pve-backup-report --check-config
pve-backup-report --check-api
pve-backup-report --check-email
pve-backup-report --dump-inventory
pve-backup-report --dump-coverage
pve-backup-report --dump-report-data
@@ -137,6 +146,7 @@ Sans installation editable :
```sh
PYTHONPATH=src python3 -m pve_backup_report --check-config
PYTHONPATH=src python3 -m pve_backup_report --check-api
PYTHONPATH=src python3 -m pve_backup_report --check-email
PYTHONPATH=src python3 -m pve_backup_report --dump-inventory
PYTHONPATH=src python3 -m pve_backup_report --dump-coverage
PYTHONPATH=src python3 -m pve_backup_report --dump-report-data