Aller au contenu

Auto-hébergement

Passer à une nouvelle version

Mettre à jour un Notifuse auto-hébergé avec Docker Compose, vérifier le résultat et revenir en arrière si besoin.

Une mise à jour remplace l’image Notifuse et la redémarre. Notifuse met à jour ses bases de données de lui-même au démarrage de la nouvelle version.

Lire d’abord le changelog

Ouvrez le changelog et lisez chaque version entre la vôtre et la nouvelle. Certaines versions ont une note Avant de mettre à jour qui décrit un changement à faire en même temps que la mise à jour, comme une nouvelle valeur de SECRET_KEY pour la 42.0 ou WEBHOOK_DELIVERY_ALLOW_PRIVATE_HOSTS pour les webhooks sur votre propre réseau.

Quand Vérifier les mises à jour est activé, l’utilisateur root et les propriétaires d’espaces de travail voient une carte sur la liste des espaces de travail dès qu’une nouvelle version sort. Son bouton Voir les nouveautés ouvre toutes les versions parues depuis la vôtre, chacune avec ses notes Avant de mettre à jour : et un lien Changelog complet.

Sauvegarder

Sauvegardez chaque base de données et conservez SECRET_KEY avec les dumps, comme l’explique Sauvegardes. Revenir à une version majeure antérieure exige cette sauvegarde (voir Revenir en arrière).

Ajoutez DB_EXPECT_EXISTING=true dans .env si ce n’est pas déjà fait. Si la mise à jour laissait un jour Notifuse face à une base vide, il s’arrêterait au lieu de démarrer une nouvelle installation.

Mettre à jour avec Docker Compose

compose.yaml prend la version dans NOTIFUSE_VERSION :

image: notifuse/notifuse:${NOTIFUSE_VERSION:-v44.0}

La valeur par défaut après :- est la version avec laquelle le fichier a été publié. Choisissez l’une des deux façons de la changer, depuis le répertoire qui contient compose.yaml.

Fixer la version dans .env

Indiquez la nouvelle version dans .env, puis téléchargez l’image et redémarrez :

# In .env: NOTIFUSE_VERSION=v44.0
docker compose pull
docker compose up -d

Télécharger le nouveau compose.yaml

Remplacez votre compose.yaml par le plus récent, puis téléchargez l’image et redémarrez. Votre .env reste tel quel. Reportez dans le nouveau fichier les modifications que vous aviez faites à compose.yaml.

curl -fsSL https://raw.githubusercontent.com/Notifuse/notifuse/main/compose.yaml -o compose.yaml
docker compose pull
docker compose up -d

Si .env définit NOTIFUSE_VERSION, cette valeur l’emporte sur celle par défaut du fichier : mettez-la à jour aussi.

docker compose pull télécharge la nouvelle image pendant que l’ancienne continue de tourner. docker compose up -d remplace ensuite le conteneur. Notifuse dispose de 70 secondes au plus pour s’arrêter : l’étape d’automation en cours et les emails en cours d’envoi se terminent d’abord.

Pour vérifier avant de redémarrer quelle version Compose va lancer, regardez l’image résolue :

docker compose config | grep 'image: notifuse'

Note

Jusqu’à la 43.0, compose.yaml construit Notifuse à partir du clone du dépôt dans lequel il se trouve. Dans un tel clone, passez sur la nouvelle version (git fetch --tags && git checkout v44.0), puis lancez docker compose up -d. À partir de la 44.0, le fichier lance l’image publiée, sauf si vous passez --build.

Ce qui se passe au démarrage

Quand la nouvelle version démarre, Notifuse exécute ses migrations de base de données avant de servir la moindre requête :

  1. Il vérifie la version de PostgreSQL. Depuis la 44.0, il refuse de démarrer sur un PostgreSQL antérieur à la 17 et indique la version trouvée.
  2. Il compare la version majeure enregistrée dans la base système (43 pour la 43.0) avec la sienne.
  3. Il applique chaque migration intermédiaire à la base système, puis à chaque base d’espace de travail.
  4. Il enregistre la nouvelle version. Certaines migrations font ensuite quitter Notifuse une fois, et Docker le relance (restart: unless-stopped).

Avec plusieurs instances sur la même base, l’une applique les migrations et les autres l’attendent (42.2 et suivantes). Suivez la progression dans le log :

docker compose logs -f api

Le log termine cette étape par Migration process completed successfully, ou par Database is up to date, no migrations needed quand la version majeure n’a pas changé. Si une migration échoue, Notifuse ne démarre pas et le log la nomme : migration failed for version ….

Vérifier la version

Connectez-vous et ouvrez la liste des espaces de travail. Son pied de page affiche la version en cours, par exemple Notifuse v44.0. Le menu du compte l’affiche aussi.

En ligne de commande, le fichier de configuration de la console la contient :

curl -s https://emails.yourcompany.com/config.js | grep VERSION

Vérifiez ensuite que https://emails.yourcompany.com/healthz répond {"status":"ok"}, et ouvrez un espace de travail pour contrôler vos données.

Revenir en arrière

Notifuse n’enregistre que la version majeure dans la base de données, et n’a pas de migrations descendantes.

Au sein d’une même version majeure (de la 44.1 à la 44.0, par exemple), indiquez la version précédente dans NOTIFUSE_VERSION et lancez docker compose up -d. Notifuse démarre sur la même base.

D’une version majeure à l’autre, l’ancienne version refuse de démarrer sur une base que la nouvelle a migrée. Le log indique database is at version 44, this build is version 43 - refusing to start. Pour revenir en arrière :

  1. Arrêtez la stack avec docker compose down.
  2. Indiquez la version précédente dans NOTIFUSE_VERSION, ou remettez son compose.yaml.
  3. Restaurez la sauvegarde faite avant la mise à jour dans une base vide, comme l’explique Restaurer, avec le SECRET_KEY en vigueur au moment de la sauvegarde.

Tout ce qui a été écrit depuis la sauvegarde est perdu.

Si la mise à jour était celle vers la 44.0, qui fait aussi passer PostgreSQL à la 18, utilisez plutôt la copie que conserve compose.yaml : Revenir en arrière remet les données PostgreSQL 17 telles qu’elles étaient avant la mise à jour, avec le compose.yaml de la version précédente.

Mettre à jour PostgreSQL

La version 44.0 fait passer compose.yaml de PostgreSQL 17 à 18, et le premier docker compose up -d sur cette version met aussi la base à jour. Mettre à jour PostgreSQL explique ce qui se passe, l’espace disque nécessaire, comment vérifier le résultat et comment revenir en arrière.