Document application update procedure

2026-05-31 07:48:17 +02:00
parent c0933bc3a1
commit 13b7e2147a
2 changed files with 50 additions and 0 deletions
@@ -132,6 +132,31 @@ PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

 Adapter `/srv/pve-backup-report` au chemin réel du dépôt. Le `cd` est important : Docker Compose y trouve `compose.yaml` et l'application y charge `.env`.

+### 🔄 Mise à jour de l'application
+
+Avant une mise à jour, conserver le fichier `.env` et le répertoire `reports/` sur un stockage persistant. Ils ne doivent pas être remplacés par l'image Docker.
+
+Depuis le répertoire du dépôt :
+
+```sh
+git pull
+docker compose build
+docker compose run --rm pve-backup-report --check-config
+docker compose run --rm pve-backup-report --check-api
+```
+
+Si les vérifications passent, relancer ensuite la génération normale du rapport ou attendre la prochaine exécution planifiée.
+
+Pour une installation locale sans Docker, mettre à jour le dépôt puis réinstaller l'application dans l'environnement virtuel :
+
+```sh
+git pull
+. .venv/bin/activate
+pip install -r requirements.txt
+pip install -e .
+pve-backup-report --check-config
+```
+
 ## 💻 Utilisation directe en ligne de commande

 Ce mode est utile pour le développement ou le diagnostic hors conteneur. L'hôte doit disposer de Python, des dépendances Python du projet et des bibliothèques système requises par WeasyPrint.
@@ -132,6 +132,31 @@ PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

 Replace `/srv/pve-backup-report` with the actual path to the repository. The `cd` is important: Docker Compose finds `compose.yaml` there and the application loads `.env` from it.

+### 🔄 Updating the application
+
+Before updating, keep the `.env` file and the `reports/` directory on persistent storage. They must not be replaced by the Docker image.
+
+From the repository directory:
+
+```sh
+git pull
+docker compose build
+docker compose run --rm pve-backup-report --check-config
+docker compose run --rm pve-backup-report --check-api
+```
+
+If the checks pass, run the normal report generation again or wait for the next scheduled execution.
+
+For a local installation without Docker, update the repository and reinstall the application in the virtual environment:
+
+```sh
+git pull
+. .venv/bin/activate
+pip install -r requirements.txt
+pip install -e .
+pve-backup-report --check-config
+```
+
 ## 💻 Direct command-line usage

 This mode is useful for development or diagnostics outside a container. The host must have Python, the project's Python dependencies and the system libraries required by WeasyPrint.