ORKA CS. Représenter avant de piloter
Aller directement au contenu du guide

Maintenance

Mettre à jour ORKA

Déployez une nouvelle version d’ORKA sans perdre votre configuration locale, vos fichiers applicatifs ni les données déjà enregistrées.

Ce guide décrit la procédure manuelle de mise à jour actuellement recommandée. La mise à jour directement depuis l’administration d’ORKA est prévue pour la fin de l’année 2026.

Temps estimé 20 à 40 minutes
Difficulté Intermédiaire
Environnement Debian ou Ubuntu
Version ORKA 1.x et suivantes
Sauvegarder
Déployer
Migrer
Vérifier

Avant de commencer

Ce que vous allez réaliser

À l’issue de ce guide, votre instance ORKA sera mise à jour tout en conservant sa configuration, ses données et les fichiers nécessaires à son exploitation.

Sauvegarder la base de données avant toute modification.

Préserver la configuration locale et les fichiers persistants.

Déployer les nouveaux fichiers applicatifs.

Mettre à jour les dépendances du backend et du frontend.

Exécuter les éventuelles migrations de base de données.

Contrôler le fonctionnement de la nouvelle version.

Mise à jour depuis l’administration

La possibilité de rechercher, télécharger et appliquer une mise à jour directement depuis l’administration d’ORKA est prévue pour la fin de l’année 2026. En attendant sa disponibilité, la procédure présentée dans ce guide reste la méthode de référence.

Diffusion des versions

Comprendre les différents types de mise à jour

Une nouvelle version d’ORKA peut contenir des corrections de sécurité, des améliorations techniques, des évolutions fonctionnelles, des migrations de base de données ou de nouvelles versions du backend et du frontend.

Sécurité

Correctifs de sécurité

Les correctifs de sécurité critiques peuvent être distribués aux utilisateurs concernés afin de corriger rapidement une vulnérabilité et de maintenir la plateforme dans un état sain.

Fonctionnel

Mises à jour fonctionnelles

Elles peuvent inclure de nouveaux modules, de nouvelles vues, des connecteurs, des améliorations métier, des tableaux de bord enrichis ou de nouvelles automatisations.

Leur accès dépend des conditions de support ou de maintenance associées à votre instance.

Majeur

Mises à jour majeures

Une version majeure peut nécessiter une procédure spécifique, une sauvegarde renforcée, une migration accompagnée ou des vérifications fonctionnelles plus approfondies.

Consultez les notes de version

Les commandes présentées dans ce guide correspondent à la procédure générale. Les notes de version accompagnant l’archive restent prioritaires lorsqu’elles indiquent une opération complémentaire ou une précaution particulière.

Point critique

Les éléments à ne jamais supprimer

Certains fichiers et répertoires appartiennent à votre instance et ne doivent pas être remplacés par ceux d’une archive de mise à jour.

backend/.env.local

Configuration locale et accès à la base de données.

backend/var/

Fichiers de travail, journaux, cache et données persistantes.

backend/var/install.lock

Verrou empêchant une réinstallation accidentelle.

Prérequis

Avant de commencer

La mise à jour doit être réalisée depuis un compte capable d’administrer l’instance et les services du serveur.

Application Instance fonctionnelle ORKA doit fonctionner avant l’intervention
Serveur Accès SSH Compte autorisé à administrer les fichiers
Base de données Accès MariaDB ou MySQL Identifiants permettant une sauvegarde complète
Archive Version à installer Archive et notes de version correspondantes
Sauvegarde Espace disponible Pour conserver les données et fichiers existants
Restauration Procédure maîtrisée Les sauvegardes doivent pouvoir être restaurées

Conseil du terrain

Lorsque l’instance est critique, reproduisez d’abord la mise à jour sur une plateforme de préproduction utilisant une copie récente de la base de données.

Étape 1

Mettre l’application en maintenance

Avant de modifier les fichiers ou la base de données, empêchez les utilisateurs de continuer à travailler dans ORKA.

Informer les utilisateurs

Annoncez le début et la durée prévue de l’intervention.

Bloquer temporairement l’accès

Utilisez une page de maintenance NGINX ou Apache.

Évitez les modifications pendant l’intervention

Une opération réalisée par un utilisateur pendant la sauvegarde ou l’exécution des migrations pourrait créer une incohérence entre les fichiers, les données sauvegardées et la nouvelle version.

Étape 2

Créer une sauvegarde complète

La sauvegarde doit être créée avant tout remplacement de fichier ou toute migration de la base de données.

Sauvegarder la base de données

Adaptez le nom de l’utilisateur et de la base de données à votre environnement.

Terminal
Commande
$ mysqldump -u orka_user -p orka \
  > orka_backup_$(date +%Y%m%d_%H%M).sql

Résultat attendu

La commande demande le mot de passe de l’utilisateur SQL, puis crée un fichier dont le nom contient la date et l’heure de la sauvegarde.

Vérifier le fichier SQL

Vérification
$ ls -lh orka_backup_*.sql

Sauvegarder les fichiers persistants

Terminal
$ cd /var/www/orka
$ sudo tar -czf \
  orka_files_backup_$(date +%Y%m%d_%H%M).tar.gz \
  backend/.env.local \
  backend/var

Conservez une copie hors du répertoire applicatif

Copiez les sauvegardes vers un emplacement distinct du serveur ou vers votre système de sauvegarde habituel. Une archive laissée uniquement dans /var/www/orka ne protège pas contre la perte du serveur ou du volume.

Étape 3

Préparer l’archive de mise à jour

Copiez l’archive fournie par ORKA CS dans un répertoire temporaire. Son nom dépend de la version distribuée.

orka-update-v1.1.zip Exemple d’archive de mise à jour ORKA
Terminal
$ sudo mkdir -p /tmp/orka-update
$ sudo chown "$(id -un)":"$(id -gn)" /tmp/orka-update
$ cp orka-update-v1.1.zip /tmp/orka-update/
$ cd /tmp/orka-update
$ unzip orka-update-v1.1.zip

Contrôle à réaliser

Vérifiez que le dossier extrait contient bien les répertoires backend et frontend, ainsi que les éventuels fichiers d’accompagnement de la version.

/tmp/orka-update
  • backend/Nouvelle version de l’API
  • frontend/Nouvelle version de l’interface
  • README.mdInformations générales
  • UPDATE.mdConsignes de mise à jour

Étape 4

Déployer les nouveaux fichiers

La commande rsync permet d’aligner les fichiers applicatifs avec la nouvelle version tout en excluant la configuration locale et le répertoire persistant.

Effectuer d’abord une simulation

L’option --dry-run affiche les opérations prévues sans modifier l’installation.

Simulation
$ sudo rsync -av --delete --dry-run \
  --exclude 'backend/.env.local' \
  --exclude 'backend/var/' \
  /tmp/orka-update/ \
  /var/www/orka/

Contrôlez la simulation avant de continuer

L’option --delete supprime de l’installation les fichiers applicatifs qui ne sont plus présents dans la nouvelle archive. Vérifiez attentivement la sortie de la simulation avant de lancer la copie réelle.

Appliquer la mise à jour

Déploiement
$ sudo rsync -av --delete \
  --exclude 'backend/.env.local' \
  --exclude 'backend/var/' \
  /tmp/orka-update/ \
  /var/www/orka/

Éléments préservés

La configuration backend/.env.local, le répertoire backend/var et le fichier backend/var/install.lock restent en place.

Étape 5

Mettre à jour le backend

Composer installe les versions de dépendances définies dans le fichier de verrouillage livré avec la nouvelle version.

Terminal
$ cd /var/www/orka/backend
$ php8.4 /usr/bin/composer install \
  --no-dev \
  --optimize-autoloader

Exemple de sortie attendue

Installing dependencies from lock file
Verifying lock file contents can be installed
Generating optimized autoload files
No security vulnerability advisories found

Utilisez la même version de PHP que PHP-FPM

Lorsque plusieurs versions de PHP sont installées, l’appel explicite à php8.4 /usr/bin/composer évite que Composer utilise une version différente de celle exécutée par le serveur Web.

Étape 6

Construire le nouveau frontend

Installez les dépendances JavaScript définies par la nouvelle version, puis reconstruisez l’interface destinée à la production.

Terminal
$ cd /var/www/orka/frontend
$ npm install
$ npm run build

Exemple de sortie attendue

vite building for production...
✓ modules transformed
dist/index.html
dist/assets/
✓ built successfully

Le répertoire frontend/dist contient désormais l’interface de la nouvelle version.

Étape 7

Exécuter les migrations de base de données

Les migrations Doctrine adaptent la structure de la base de données aux besoins de la nouvelle version.

Terminal
$ cd /var/www/orka/backend
$ php8.4 bin/console doctrine:migrations:migrate \
  --no-interaction

Résultat attendu

Doctrine affiche les migrations exécutées et confirme que la base de données correspond désormais à la version attendue.

Contrôler l’état des migrations

Vérification
$ php8.4 bin/console doctrine:migrations:status

Étape 8

Nettoyer et reconstruire le cache Symfony

Le cache de l’ancienne version ne doit pas être réutilisé par la nouvelle application.

Terminal
$ cd /var/www/orka/backend
$ php8.4 bin/console cache:clear --env=prod
$ php8.4 bin/console cache:warmup --env=prod

Résultat attendu

Symfony confirme que le cache de production a été supprimé puis reconstruit avec les fichiers de la nouvelle version.

Étape 9

Vérifier les permissions

Après le remplacement des fichiers et la reconstruction du cache, vérifiez que PHP-FPM peut écrire dans les emplacements nécessaires.

Terminal
$ sudo chmod -R 775 /var/www/orka/backend/var
$ sudo chmod -R 775 /var/www/orka/backend/public

Lorsque le serveur Web utilise le compte www-data, vérifiez également que le propriétaire ou le groupe lui permet d’accéder aux fichiers.

Alternative
$ sudo chown -R www-data:www-data \
  /var/www/orka/backend/var

N’utilisez pas de permissions 777

ORKA ne nécessite pas de droits ouverts à tous les utilisateurs du serveur. Utilisez des permissions adaptées au compte de déploiement et au groupe du serveur Web.

Étape 10

Redémarrer les services

Redémarrez PHP-FPM ainsi que le serveur Web afin que les processus utilisent la nouvelle version des fichiers.

Avec NGINX

Terminal
$ sudo systemctl restart php8.4-fpm
$ sudo systemctl restart nginx

Avec Apache

Terminal
$ sudo systemctl restart php8.4-fpm
$ sudo systemctl restart apache2

Contrôler leur état

Vérification NGINX
$ sudo systemctl status php8.4-fpm
$ sudo systemctl status nginx

Résultat attendu

Les services doivent apparaître dans l’état active (running).

Contrôle final

Vérifier que la mise à jour est opérationnelle

Rouvrez temporairement l’accès depuis votre poste d’administration et effectuez les contrôles suivants avant de remettre l’application à disposition de tous les utilisateurs.

La page /login est accessible.

La connexion avec un compte administrateur fonctionne.

Le tableau de bord se charge sans erreur.

Le menu d’administration reste accessible.

Les données existantes sont toujours présentes.

Les principales pages fonctionnelles s’affichent correctement.

Aucune erreur HTTP 500 n’est visible.

Aucune erreur JavaScript critique n’apparaît dans la console.

Le fichier backend/var/install.lock est présent.

Vérifier la version installée

Lorsque la version est affichée dans l’administration d’ORKA, vérifiez qu’elle correspond à celle de l’archive déployée.

Exemple
ORKA 1.1.0

Surveiller les journaux

Après la réouverture, surveillez les journaux de PHP-FPM, du serveur Web et d’ORKA afin d’identifier rapidement une erreur qui ne serait pas immédiatement visible dans l’interface.

Surveillance
$ sudo journalctl -u php8.4-fpm -f
$ sudo tail -f /var/log/nginx/error.log
$ sudo tail -f /var/www/orka/backend/var/log/prod.log

Mise à jour terminée

Votre plateforme ORKA est à jour.

Vous pouvez rouvrir l’accès aux utilisateurs, noter la version installée dans votre documentation d’exploitation et conserver les sauvegardes pendant quelques jours.

En cas d’échec

Restaurer la version précédente

Si une erreur empêche l’utilisation normale de la plateforme, laissez l’application en maintenance et restaurez les sauvegardes créées avant l’intervention.

Restaurer les fichiers

Restauration
$ cd /var/www/orka
$ sudo tar -xzf \
  orka_files_backup_YYYYMMDD_HHMM.tar.gz \
  -C /var/www/orka

Restaurer la base de données

Restauration
$ mysql -u orka_user -p orka \
  < orka_backup_YYYYMMDD_HHMM.sql

Redémarrer les services

Terminal
$ sudo systemctl restart php8.4-fpm
$ sudo systemctl restart nginx

Recommencez les contrôles fonctionnels

Après une restauration, vérifiez à nouveau la connexion, les données, le tableau de bord, les journaux et l’état des services avant de rouvrir l’accès.

Numérotation

Comprendre le numéro de version

ORKA utilise une numérotation composée de trois valeurs.

MAJOR MINOR PATCH
PATCH

Correction technique ou de sécurité

Une version PATCH corrige un défaut sans apporter de modification fonctionnelle majeure.

1.0.0 → 1.0.1
MINOR

Nouvelle fonctionnalité compatible

Une version MINOR apporte une évolution tout en conservant la compatibilité générale avec la version précédente.

1.0.1 → 1.1.0
MAJOR

Évolution importante

Une version MAJOR peut modifier profondément la plateforme et demander une préparation ou une migration spécifique.

1.1.0 → 2.0.0

En cas de difficulté

Dépannage courant

Composer signale une version de PHP incompatible

Vérifiez la version utilisée avec php8.4 -v, puis exécutez Composer explicitement avec php8.4 /usr/bin/composer.

La migration Doctrine échoue

Conservez le message d’erreur complet, vérifiez les notes de version et contrôlez l’accès à la base de données. Ne relancez pas plusieurs fois une migration en échec sans avoir identifié sa cause.

ORKA affiche une erreur 500 après la mise à jour

Contrôlez les journaux de PHP-FPM et le fichier backend/var/log/prod.log. Vérifiez également les permissions de backend/var et la présence du fichier backend/.env.local.

Le frontend affiche une page blanche

Exécutez à nouveau npm run build, puis vérifiez la présence du fichier frontend/dist/index.html et consultez la console JavaScript du navigateur.

Les données semblent avoir disparu

Vérifiez que le fichier backend/.env.local n’a pas été remplacé et que l’application utilise toujours la bonne base de données. Ne créez pas une nouvelle installation.

L’assistant d’installation est de nouveau accessible

Vérifiez immédiatement la présence du fichier backend/var/install.lock. Ne relancez jamais une installation complète sur une instance existante.

La nouvelle version ne s’affiche pas

Vérifiez que les fichiers ont été copiés depuis le bon répertoire, que le frontend a été reconstruit et que PHP-FPM ainsi que le serveur Web ont été redémarrés.

Bonnes pratiques

Maintenir une procédure maîtrisée

Lire les notes de version avant chaque intervention.

Sauvegarder les fichiers et la base de données.

Tester la mise à jour en préproduction lorsque cela est possible.

Planifier l’intervention en dehors d’une période critique.

Conserver l’archive de la version précédente.

Documenter la date, la version et le résultat de l’intervention.

Conserver les sauvegardes plusieurs jours après la mise à jour.