Pular para o conteúdo

Auto-hospedagem

Mudar de domínio

Mova uma instância do Notifuse para um novo endereço e abra o console nos domínios personalizados dos workspaces.

O Notifuse obtém o seu endereço público de API_ENDPOINT, definido como variável de ambiente ou salvo pelo assistente de configuração; quando os dois existem, a variável de ambiente prevalece. O console envia todas as solicitações para esse endereço, e ele é gravado nos emails, nos convites, nos webhooks registrados nos seus provedores de email e no URI de redirecionamento do SSO. Para mover uma instância, altere API_ENDPOINT e depois atualize os lugares que copiaram o endereço.

Atenção

Mantenha o domínio antigo apontando para o Notifuse, ou redirecionando para o novo com o caminho e a query string intactos, enquanto as pessoas puderem abrir emails que você já enviou. Os links de rastreamento, de cancelamento de inscrição, da central de notificações e da versão web desses emails trazem o endereço antigo, e um email entregue não pode ser atualizado.

Passar para o novo domínio

  1. Encaminhe o novo domínio para o Notifuse no seu proxy reverso, com um certificado TLS, e mantenha o domínio antigo encaminhado também.
  2. Altere API_ENDPOINT:
    • Definido como variável de ambiente: altere o valor e reinicie o Notifuse.
    • Salvo pelo assistente de configuração: entre como root no domínio antigo, abra Configurações do Sistema (o botão acima da lista de workspaces), altere Endpoint API e salve. Salvar reinicia o Notifuse: o processo é encerrado e o seu contêiner ou gerenciador de serviços o inicia de novo (o arquivo Docker Compose fornecido faz isso com restart: unless-stopped). O campo fica desativado quando a variável de ambiente está definida, já que ela o substituiria.
  3. Entre de novo no novo domínio. As sessões são mantidas por endereço, então uma sessão aberta no domínio antigo não passa para o novo.
  4. Percorra a lista abaixo.

Nota

Perdeu o acesso depois da mudança? Se o domínio antigo não chega mais ao Notifuse, o console no novo domínio também não consegue acessar a sua API; a página de login mostra o endereço que tentou usar. Defina API_ENDPOINT com o novo endereço como variável de ambiente e reinicie: ela substitui o valor salvo pelo assistente de configuração.

O que mais usa o endereço

Usa o endereçoDepois da mudançaO que fazer
Links em emails já enviados: rastreamento de cliques, rastreamento de aberturas, cancelamento de inscrição, List-Unsubscribe, central de notificações, versão webContinuam apontando para o domínio antigoMantenha o domínio antigo encaminhado para o Notifuse. Os workspaces com uma URL de endpoint personalizada usam esse domínio e não são afetados. Se você redirecionar o domínio antigo para o novo, os links de cancelamento de inscrição e da central de notificações envolvidos pelo rastreamento de cliques em emails enviados antes da 42.2 mostram primeiro uma página de confirmação, o que custa um clique a mais. Quando um workspace muda o seu próprio domínio personalizado, redirecione o antigo para API_ENDPOINT, e não para o novo domínio personalizado: uma versão web só abre no domínio com que foi enviada e em API_ENDPOINT.
Convites pendentes para workspacesTêm link para o domínio antigoMantenha o domínio antigo encaminhado ou reenvie os convites: um convite reenviado usa o novo endereço.
Webhooks dos provedores de emailRegistrados uma única vez, com o endereço da épocaPara cada integração, abra Configurações → Integrações e escolha Registrar webhooks novamente no menu ⋯ dela. Veja Webhooks dos provedores de email.
WEBHOOK_ENDPOINTSubstitui API_ENDPOINT para os webhooks quando definidoAltere essa variável também e registre os webhooks de novo.
Login únicoO URI de redirecionamento deriva de API_ENDPOINT, a menos que OIDC_REDIRECT_URI esteja definidoAdicione https://<new-domain>/api/user.oidc.callback no seu provedor de identidade e atualize OIDC_REDIRECT_URI se você o definiu. Veja Login único.
URLs copiadas para outras ferramentas: hooks de autenticação do Supabase, a conexão do Zapier, aplicações que chamam a APIContinuam chamando o domínio antigoAtualize-as com o novo endereço.
O snippet de análise web instalado nos seus sitesO endpoint e a URL do script dele indicam o domínio antigo, a menos que o workspace tenha uma URL de endpoint personalizadaInstale o snippet atualizado ou mantenha o domínio antigo encaminhado.
URLs de endpoint personalizadas dos workspacesA verificação de DNS espera um CNAME para o host de API_ENDPOINT, e só roda quando um domínio personalizado é definido ou alteradoOs domínios personalizados existentes continuam funcionando enquanto o destino do CNAME deles ainda chegar ao Notifuse. Aponte-os para o novo host quando for conveniente.
CORS_ALLOW_ORIGINLista as origens autorizadas a chamar a API, quando definidoAdicione a nova origem. Veja Domínios personalizados dos workspaces.

Webhooks dos provedores de email

O Notifuse registra o seu webhook no seu provedor de email quando você cria a integração, com o endereço daquele momento, e nunca o atualiza sozinho. Registrar webhooks novamente envia o novo endereço:

  • Mailgun e SendGrid substituem o endereço antigo.
  • Postmark, SparkPost, Mailjet e Amazon SES adicionam o novo endereço ao lado do antigo. Exclua o webhook antigo no painel do provedor, ou, no caso do Amazon SES, a assinatura SNS antiga, para que os eventos não sejam entregues em dobro.

Uma integração pode aparecer como registrada enquanto o webhook dela ainda aponta para o domínio antigo. Passe o mouse sobre o status dos webhooks de uma integração em Configurações → Integrações para ver o endereço que cada endpoint usa.

O Amazon SES confirma a nova assinatura SNS automaticamente, assim que a AWS consegue chegar ao Notifuse no novo domínio.

Abrir o console no domínio personalizado de um workspace

A URL de endpoint personalizada de um workspace também serve o console: se um workspace usa https://news.example.com, os membros dele podem entrar em https://news.example.com/console. O console e a central de notificações abertos ali enviam as solicitações para API_ENDPOINT, a partir da origem do domínio personalizado.

  • Com o valor padrão de CORS_ALLOW_ORIGIN (*), não há nada a configurar.
  • Se você restringir CORS_ALLOW_ORIGIN, liste todos os domínios personalizados dos workspaces, separados por vírgulas: CORS_ALLOW_ORIGIN=https://news.example.com,https://mail.other-brand.com. Num domínio que ficar de fora, não é possível entrar no console, e a central de notificações dele não consegue carregar as preferências.
  • As sessões são mantidas por endereço: entrar num domínio personalizado não abre a sua sessão no domínio principal, e vice-versa.
  • O login único e os links de convite terminam no endereço de API_ENDPOINT, não no domínio personalizado.