Aller au contenu

Auto-hébergement

Changer de domaine

Déplacer une instance Notifuse vers une nouvelle adresse, et ouvrir la console sur les domaines personnalisés des espaces de travail.

Notifuse tire son adresse publique de API_ENDPOINT, défini comme variable d’environnement ou enregistré par l’assistant d’installation ; la variable d’environnement l’emporte quand les deux existent. La console y envoie toutes ses requêtes, et l’adresse est inscrite dans les emails, les invitations, les webhooks enregistrés auprès de vos fournisseurs d’email et l’URI de redirection SSO. Pour déplacer une instance, changez API_ENDPOINT, puis mettez à jour les endroits qui l’ont recopiée.

Attention

Gardez l’ancien domaine pointé vers Notifuse, ou redirigé vers le nouveau en conservant le chemin et la query string, tant que des personnes peuvent ouvrir des emails déjà envoyés. Leurs liens de suivi, de désabonnement, du centre de notifications et de version web portent l’ancienne adresse, et un email remis ne peut plus être modifié.

Passer au nouveau domaine

  1. Routez le nouveau domaine vers Notifuse dans votre reverse proxy, avec un certificat TLS, et gardez aussi l’ancien domaine routé.
  2. Changez API_ENDPOINT :
    • Défini comme variable d’environnement : modifiez-la et redémarrez Notifuse.
    • Enregistré par l’assistant d’installation : connectez-vous en root sur l’ancien domaine, ouvrez Paramètres système (le bouton au-dessus de la liste des espaces de travail), modifiez Point d’accès API et enregistrez. L’enregistrement redémarre Notifuse : le processus s’arrête et votre conteneur ou votre gestionnaire de services le relance (le fichier Docker Compose fourni le fait avec restart: unless-stopped). Le champ est désactivé quand la variable d’environnement est définie, puisqu’elle prendrait le dessus.
  3. Reconnectez-vous sur le nouveau domaine. Les sessions sont propres à chaque adresse : une session ouverte sur l’ancien domaine ne suit pas.
  4. Passez en revue la liste ci-dessous.

Note

Bloqué après le déplacement ? Si l’ancien domaine n’atteint plus Notifuse, la console du nouveau domaine ne peut pas non plus joindre son API ; la page de connexion affiche l’adresse qu’elle a essayée. Définissez API_ENDPOINT avec la nouvelle adresse comme variable d’environnement et redémarrez : elle prend le dessus sur la valeur enregistrée par l’assistant d’installation.

Ce qui utilise aussi l’adresse

Utilise l’adresseAprès le changementQue faire
Liens des emails déjà envoyés : suivi des clics, suivi des ouvertures, désabonnement, List-Unsubscribe, centre de notifications, version webPointent toujours vers l’ancien domaineGardez l’ancien domaine routé vers Notifuse. Les espaces de travail dotés d’une URL de point d’accès personnalisée utilisent ce domaine à la place et ne sont pas concernés. Si vous redirigez l’ancien domaine vers le nouveau, les liens de désabonnement et du centre de notifications enveloppés par le suivi des clics dans les emails envoyés avant 42.2 affichent d’abord une page de confirmation, ce qui coûte un clic de plus. Quand un espace de travail change son propre domaine personnalisé, redirigez l’ancien vers API_ENDPOINT, et non vers le nouveau domaine personnalisé : une version web ne s’ouvre que sur le domaine avec lequel elle a été envoyée et sur API_ENDPOINT.
Invitations en attente dans les espaces de travailPointent vers l’ancien domaineGardez l’ancien domaine routé, ou renvoyez les invitations : une invitation renvoyée utilise la nouvelle adresse.
Webhooks des fournisseurs d’emailEnregistrés une seule fois, avec l’adresse de l’époquePour chaque intégration, ouvrez Paramètres → Intégrations et choisissez Réenregistrer les webhooks dans son menu ⋯. Voir Webhooks des fournisseurs d’email.
WEBHOOK_ENDPOINTRemplace API_ENDPOINT pour les webhooks quand elle est définieChangez-la aussi, puis réenregistrez.
Authentification uniqueL’URI de redirection est déduite de API_ENDPOINT, sauf si OIDC_REDIRECT_URI est définieAjoutez https://<new-domain>/api/user.oidc.callback chez votre fournisseur d’identité, et mettez à jour OIDC_REDIRECT_URI si vous l’avez définie. Voir Authentification unique.
URL recopiées dans d’autres outils : hooks d’authentification Supabase, connexion Zapier, applications qui appellent l’APIAppellent toujours l’ancien domaineMettez-les à jour avec la nouvelle adresse.
Le snippet d’analyse web installé sur vos sitesSon endpoint et l’URL de son script nomment l’ancien domaine, sauf si l’espace de travail a une URL de point d’accès personnaliséeInstallez le snippet mis à jour, ou gardez l’ancien domaine routé.
URL de point d’accès personnalisées des espaces de travailLeur vérification DNS attend un CNAME vers l’hôte de API_ENDPOINT, et ne s’exécute que quand un domaine personnalisé est défini ou modifiéLes domaines personnalisés existants continuent de fonctionner tant que la cible de leur CNAME atteint Notifuse. Faites-les pointer vers le nouvel hôte quand cela vous arrange.
CORS_ALLOW_ORIGINListe les origines autorisées à appeler l’API, quand elle est définieAjoutez la nouvelle origine. Voir Domaines personnalisés des espaces de travail.

Webhooks des fournisseurs d’email

Notifuse enregistre son webhook auprès de votre fournisseur d’email à la création de l’intégration, avec l’adresse du moment, et ne le met jamais à jour de lui-même. Réenregistrer les webhooks envoie la nouvelle adresse :

  • Mailgun et SendGrid remplacent l’ancienne adresse.
  • Postmark, SparkPost, Mailjet et Amazon SES ajoutent la nouvelle adresse à côté de l’ancienne. Supprimez l’ancien webhook dans le tableau de bord du fournisseur, ou pour Amazon SES l’ancien abonnement SNS, pour que les événements ne soient pas livrés deux fois.

Une intégration peut apparaître comme enregistrée alors que son webhook pointe encore vers l’ancien domaine. Survolez le statut des webhooks d’une intégration dans Paramètres → Intégrations pour voir l’adresse utilisée par chaque point d’accès.

Amazon SES confirme automatiquement le nouvel abonnement SNS, dès qu’AWS peut joindre Notifuse sur le nouveau domaine.

Ouvrir la console sur le domaine personnalisé d’un espace de travail

L’URL de point d’accès personnalisée d’un espace de travail sert aussi la console : si un espace de travail utilise https://news.example.com, ses membres peuvent se connecter sur https://news.example.com/console. La console et le centre de notifications ouverts à cette adresse envoient leurs requêtes à API_ENDPOINT, depuis l’origine du domaine personnalisé.

  • Avec la valeur par défaut de CORS_ALLOW_ORIGIN (*), il n’y a rien à configurer.
  • Si vous restreignez CORS_ALLOW_ORIGIN, listez chaque domaine personnalisé d’espace de travail, séparés par des virgules : CORS_ALLOW_ORIGIN=https://news.example.com,https://mail.other-brand.com. Un domaine oublié ne permet pas de se connecter à la console, et son centre de notifications ne peut pas charger les préférences.
  • Les sessions sont propres à chaque adresse : se connecter sur un domaine personnalisé ne vous connecte pas sur le domaine principal, et inversement.
  • Les liens d’authentification unique et d’invitation aboutissent sur l’adresse API_ENDPOINT, et non sur le domaine personnalisé.