Zum Inhalt springen

Self-Hosting

Domain wechseln

Ziehen Sie eine Notifuse-Instanz auf eine neue Adresse um und öffnen Sie die Konsole auf den eigenen Domains der Arbeitsbereiche.

Notifuse bezieht seine öffentliche Adresse aus API_ENDPOINT, das als Umgebungsvariable gesetzt oder vom Einrichtungsassistenten gespeichert wird; gibt es beides, gewinnt die Umgebungsvariable. Die Konsole schickt jede Anfrage an diese Adresse, und sie steht in E-Mails, Einladungen, den bei Ihren E-Mail-Anbietern registrierten Webhooks und der SSO-Redirect-URI. Um eine Instanz umzuziehen, ändern Sie API_ENDPOINT und passen dann die Stellen an, die die Adresse übernommen haben.

Warnung

Lassen Sie die alte Domain auf Notifuse zeigen oder mit unverändertem Pfad und Query-String auf die neue weiterleiten, solange jemand bereits versendete E-Mails öffnen könnte. Deren Tracking-, Abmelde-, Benachrichtigungscenter- und Webversion-Links enthalten die alte Adresse, und eine zugestellte E-Mail lässt sich nicht mehr ändern.

Auf die neue Domain umstellen

  1. Leiten Sie die neue Domain in Ihrem Reverse Proxy mit einem TLS-Zertifikat an Notifuse weiter, und leiten Sie die alte Domain weiterhin dorthin weiter.
  2. Ändern Sie API_ENDPOINT:
    • Als Umgebungsvariable gesetzt: Ändern Sie den Wert und starten Sie Notifuse neu.
    • Vom Einrichtungsassistenten gespeichert: Melden Sie sich als Root auf der alten Domain an, öffnen Sie Systemeinstellungen (die Schaltfläche über der Liste der Arbeitsbereiche), ändern Sie API-Endpunkt und speichern Sie. Das Speichern startet Notifuse neu: Der Prozess beendet sich, und Ihr Container- oder Dienstmanager startet ihn wieder (die mitgelieferte Docker-Compose-Datei erledigt das mit restart: unless-stopped). Ist die Umgebungsvariable gesetzt, ist das Feld deaktiviert, da die Variable den Wert überschreiben würde.
  3. Melden Sie sich auf der neuen Domain erneut an. Sitzungen gelten pro Adresse, eine auf der alten Domain geöffnete Sitzung wird also nicht übernommen.
  4. Gehen Sie die folgende Liste durch.

Hinweis

Nach dem Umzug ausgesperrt? Erreicht die alte Domain Notifuse nicht mehr, erreicht auch die Konsole auf der neuen Domain ihre API nicht; die Anmeldeseite zeigt die Adresse, die sie versucht hat. Setzen Sie API_ENDPOINT als Umgebungsvariable auf die neue Adresse und starten Sie neu: Die Variable überschreibt den vom Einrichtungsassistenten gespeicherten Wert.

Was die Adresse sonst noch verwendet

Verwendet die AdresseNach der ÄnderungWas zu tun ist
Links in bereits versendeten E-Mails: Klick-Tracking, Öffnungs-Tracking, Abmeldung, List-Unsubscribe, Benachrichtigungscenter, WebversionZeigen weiter auf die alte DomainLeiten Sie die alte Domain weiterhin an Notifuse weiter. Arbeitsbereiche mit einer benutzerdefinierten Endpunkt-URL verwenden stattdessen diese Domain und sind nicht betroffen. Leiten Sie die alte Domain auf die neue um, zeigen Abmelde- und Benachrichtigungscenter-Links, die in vor 42.2 versendeten E-Mails vom Klick-Tracking umschlossen sind, zuerst eine Bestätigungsseite, was einen zusätzlichen Klick kostet. Ändert ein Arbeitsbereich seine eigene Domain, leiten Sie die alte auf API_ENDPOINT um, nicht auf die neue eigene Domain: Eine Webversion öffnet sich nur auf der Domain, mit der sie versendet wurde, und auf API_ENDPOINT.
Offene Einladungen in ArbeitsbereicheVerlinken auf die alte DomainLeiten Sie die alte Domain weiterhin an Notifuse weiter, oder senden Sie die Einladungen erneut: Eine erneut gesendete Einladung verwendet die neue Adresse.
Webhooks der E-Mail-AnbieterEinmal registriert, mit der damaligen AdresseÖffnen Sie für jede Integration Einstellungen → Integrationen und wählen Sie in ihrem Menü ⋯ den Eintrag Webhooks erneut registrieren. Siehe Webhooks der E-Mail-Anbieter.
WEBHOOK_ENDPOINTÜberschreibt API_ENDPOINT für Webhooks, wenn gesetztÄndern Sie ihn ebenfalls und registrieren Sie die Webhooks danach erneut.
Single Sign-onDie Redirect-URI wird aus API_ENDPOINT abgeleitet, außer OIDC_REDIRECT_URI ist gesetztTragen Sie https://<new-domain>/api/user.oidc.callback bei Ihrem Identity Provider ein, und passen Sie OIDC_REDIRECT_URI an, falls Sie die Variable gesetzt haben. Siehe Single Sign-on.
In andere Tools kopierte URLs: Supabase-Auth-Hooks, die Zapier-Verbindung, Anwendungen, die die API aufrufenRufen weiter die alte Domain aufTragen Sie dort die neue Adresse ein.
Das auf Ihren Websites installierte Web-Analyse-SnippetSein endpoint und seine Skript-URL nennen die alte Domain, außer der Arbeitsbereich hat eine benutzerdefinierte Endpunkt-URLInstallieren Sie das aktualisierte Snippet oder leiten Sie die alte Domain weiterhin an Notifuse weiter.
Benutzerdefinierte Endpunkt-URLs der ArbeitsbereicheIhre DNS-Prüfung erwartet einen CNAME auf den Host von API_ENDPOINT und läuft nur, wenn eine eigene Domain gesetzt oder geändert wirdBestehende eigene Domains funktionieren weiter, solange ihr CNAME-Ziel Notifuse noch erreicht. Richten Sie sie bei Gelegenheit auf den neuen Host aus.
CORS_ALLOW_ORIGINListet die Origins, die die API aufrufen dürfen, wenn gesetztFügen Sie den neuen Origin hinzu. Siehe Eigene Domains der Arbeitsbereiche.

Webhooks der E-Mail-Anbieter

Notifuse registriert seinen Webhook bei Ihrem E-Mail-Anbieter, wenn Sie die Integration anlegen, mit der Adresse dieses Zeitpunkts, und aktualisiert ihn nie von sich aus. Webhooks erneut registrieren sendet die neue Adresse:

  • Mailgun und SendGrid ersetzen die alte Adresse.
  • Postmark, SparkPost, Mailjet und Amazon SES fügen die neue Adresse neben der alten hinzu. Löschen Sie den alten Webhook im Dashboard des Anbieters, bei Amazon SES das alte SNS-Abonnement, damit Ereignisse nicht doppelt zugestellt werden.

Eine Integration kann als registriert erscheinen, obwohl ihr Webhook noch auf die alte Domain zeigt. Fahren Sie unter Einstellungen → Integrationen mit der Maus über den Webhook-Status einer Integration, um die Adresse jedes Endpunkts zu sehen.

Amazon SES bestätigt das neue SNS-Abonnement automatisch, sobald AWS Notifuse auf der neuen Domain erreicht.

Die Konsole auf der eigenen Domain eines Arbeitsbereichs öffnen

Die benutzerdefinierte Endpunkt-URL eines Arbeitsbereichs liefert auch die Konsole aus: Verwendet ein Arbeitsbereich https://news.example.com, können sich seine Mitglieder unter https://news.example.com/console anmelden. Die dort geöffnete Konsole und das Benachrichtigungscenter senden ihre Anfragen an API_ENDPOINT, vom Origin der eigenen Domain aus.

  • Mit dem Standardwert von CORS_ALLOW_ORIGIN (*) ist nichts zu konfigurieren.
  • Wenn Sie CORS_ALLOW_ORIGIN einschränken, führen Sie jede eigene Domain eines Arbeitsbereichs auf, durch Kommas getrennt: CORS_ALLOW_ORIGIN=https://news.example.com,https://mail.other-brand.com. Über eine fehlende Domain kann man sich nicht bei der Konsole anmelden, und ihr Benachrichtigungscenter kann keine Einstellungen laden.
  • Sitzungen gelten pro Adresse: Eine Anmeldung auf einer eigenen Domain meldet Sie nicht auf der Hauptdomain an, und umgekehrt.
  • Single Sign-on und Einladungslinks enden auf der Adresse von API_ENDPOINT, nicht auf der eigenen Domain.