Mise à jour de LockSelf v4 (On-Premises)

Mises à jour • LockSelf V4 On-Premises

Présentation

Cet article décrit comment mettre à jour une installation LockSelf V4 On-Premises à l'aide du script v4-installer.sh. La mise à jour consiste à charger de nouvelles images (API et/ou Webapp), à mettre à jour le fichier compose, puis à redémarrer le composant concerné.

Deux composants peuvent être mis à jour indépendamment :

  • API stack — lockself-api + workers (messenger-async, messenger-low)
  • Webapp — proxy web + frontend

Prérequis : disposez de la ou des nouvelles archives d'images (lockself-apiv4-X.X.X.X.tar.gz et/ou lockself-webappv4-X.X.X.X.tar.gz). Vous ne les avez pas reçues ? Rapprochez-vous de votre CSM ou contactez support@lockself.com.

 

Point d'attention important

Le fichier compose contient le tag de l'image en dur. Charger une nouvelle image sans mettre à jour le compose ferait redémarrer l'ancienne version.

N'utilisez donc jamais un simple docker load suivi d'un redémarrage. Utilisez toujours les commandes de mise à jour dédiées (menu ou flags), qui garantissent la cohérence image + compose + redémarrage.

 

Mise à jour via le menu de gestion

Lancez le script depuis le répertoire d'installation :

bash v4-installer.sh

Le script détecte l'installation, exécute le Doctor et ouvre le menu de gestion. Utilisez alors :

  • Option 5 — Mettre à jour l'image de l'API depuis une archive .tar.gz (chargement → mise à jour du compose → redémarrage).
  • Option 7 — Mettre à jour l'image de la Webapp depuis une archive .tar.gz (chargement → mise à jour du compose → redémarrage).

Si l'archive se trouve dans le répertoire courant, elle est détectée automatiquement ; sinon, indiquez son chemin.

 

Mise à jour en ligne de commande

Le script expose des flags d'action permettant de mettre à jour sans passer par le menu — idéal pour les scripts de déploiement, les pipelines CI/CD ou les crons de maintenance.

# Mise à jour de l'API (archive explicite)
bash v4-installer.sh --update-api lockself-api.4.2.0.0.tar.gz

# Mise à jour de la Webapp (archive explicite)
bash v4-installer.sh --update-webapp lockself-webapp.4.2.0.0.tar.gz

# Si les archives sont dans le répertoire courant, l'auto-détection fonctionne
bash v4-installer.sh --update-api
bash v4-installer.sh --update-webapp

Chaque flag effectue les trois étapes en une seule commande : charger la nouvelle archive, mettre à jour le compose avec le nouveau tag, puis redémarrer le composant.

Résolution du chemin d'installation

Les flags d'action ont besoin de connaître le chemin d'installation. Ils le résolvent dans cet ordre :

  1. --path <dir> — chemin explicite.
  2. --config <file> — chemin déduit du fichier de configuration.
  3. Auto-détection dans le répertoire courant.

Si aucune installation n'est trouvée au chemin résolu, le script affiche une erreur explicite.

 

Intégrer la mise à jour dans un script de déploiement

#!/bin/bash
set -e

# Mise à jour des images + compose + redémarrage
bash v4-installer.sh --config /etc/lockself/lockself.env --update-api    lockself-api.4.2.0.0.tar.gz
bash v4-installer.sh --config /etc/lockself/lockself.env --update-webapp lockself-webapp.4.2.0.0.tar.gz

# Vérification post-déploiement
bash v4-installer.sh --config /etc/lockself/lockself.env --doctor

 

Redémarrer les composants

Indépendamment d'une mise à jour, vous pouvez redémarrer les composants via les flags suivants :

  • --restart-api — redémarre l'API stack (lockself-api + workers).
  • --restart-webapp — redémarre la Webapp.
  • --restart-mariadb — redémarre MariaDB (base incluse uniquement ; échoue si la base est externe).
  • --restart-all — redémarre tous les composants dans l'ordre (MariaDB → API → Webapp).

Les mêmes actions sont disponibles depuis le menu de gestion (options 4, 6 et 8).

 

Autres actions d'administration

Le menu de gestion permet également de modifier la configuration après installation :

  • Option 0 — Mettre à jour les informations de base de données.
  • Option 1 — Régénérer les clés JWT.
  • Option 2 — Mettre à jour la configuration SMTP.
  • Option 3 — Mettre à jour le nom de domaine.
  • Option 10 — Régénérer le certificat SAML SP.

 

Vérifier après une mise à jour

Après toute mise à jour, exécutez le Doctor pour confirmer que les composants sont bien opérationnels :

bash v4-installer.sh --doctor

Tous les conteneurs concernés doivent afficher le statut UP. En cas d'anomalie, consultez l'article de dépannage (Troubleshooting).

Mise à jour