Pular para o conteúdo

Auto-hospedagem

Atualizar para uma nova versão

Atualize um Notifuse auto-hospedado para uma nova versão com Docker Compose, verifique o resultado e reverta se for preciso.

Uma atualização substitui a imagem do Notifuse e o reinicia. O Notifuse atualiza os seus bancos de dados sozinho quando inicia na nova versão.

Leia o changelog antes

Abra o changelog e leia todas as versões entre a sua e a nova. Algumas versões têm uma nota Antes de atualizar com uma mudança a fazer na mesma etapa da atualização, como um novo valor de SECRET_KEY na 42.0 ou WEBHOOK_DELIVERY_ALLOW_PRIVATE_HOSTS para webhooks na sua própria rede.

Quando Verificar atualizações está ativado, o usuário root e os proprietários de workspace veem um cartão na lista de workspaces quando sai uma nova versão. O botão Ver as novidades abre todas as versões desde a sua, cada uma com as suas notas Antes de atualizar: e um link Changelog completo.

Faça um backup

Faça backup de todos os bancos de dados e guarde a SECRET_KEY junto com os dumps, como mostra Backups. Reverter para uma versão principal anterior exige esse backup (veja Reverter).

Defina DB_EXPECT_EXISTING=true no .env, se ainda não estiver lá. Se a atualização deixasse o Notifuse diante de um banco de dados vazio, ele pararia em vez de iniciar uma nova instalação.

Atualizar com Docker Compose

O compose.yaml obtém a versão de NOTIFUSE_VERSION:

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

O valor padrão depois de :- é a versão com que o arquivo foi publicado. Escolha uma das duas formas de alterá-la, a partir do diretório que contém o compose.yaml.

Fixar a versão no .env

Defina a nova versão no .env, depois baixe a imagem e reinicie:

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

Baixar o novo compose.yaml

Substitua o seu compose.yaml pelo mais recente, depois baixe a imagem e reinicie. O seu .env fica como está. Copie para o novo arquivo qualquer alteração que você tenha feito no compose.yaml.

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

Se o .env define NOTIFUSE_VERSION, esse valor prevalece sobre o padrão do arquivo: atualize-o também.

docker compose pull baixa a nova imagem enquanto a antiga continua rodando. Depois, docker compose up -d substitui o contêiner. O Notifuse tem até 70 segundos para parar: a etapa de automação em andamento e os emails que estão sendo enviados terminam antes.

Para verificar qual versão o Compose vai rodar antes de reiniciar, veja a imagem resolvida:

docker compose config | grep 'image: notifuse'

Nota

Até a 43.0, o compose.yaml compila o Notifuse a partir do clone do repositório em que ele está. Num clone assim, faça checkout da nova versão (git fetch --tags && git checkout v44.0) e depois rode docker compose up -d. A partir da 44.0, o arquivo roda a imagem publicada, a menos que você passe --build.

O que acontece na inicialização

Quando a nova versão inicia, o Notifuse roda as migrações de banco de dados antes de atender qualquer solicitação:

  1. Ele verifica a versão do PostgreSQL. Desde a 44.0, ele se recusa a iniciar num PostgreSQL anterior ao 17 e informa a versão que encontrou.
  2. Ele compara a versão principal registrada no banco de dados do sistema (43 para a 43.0) com a sua.
  3. Ele aplica cada migração intermediária ao banco de dados do sistema e depois a cada banco de dados de workspace.
  4. Ele registra a nova versão. Algumas migrações fazem o Notifuse encerrar uma vez em seguida, e o Docker o inicia de novo (restart: unless-stopped).

Com várias instâncias no mesmo banco de dados, uma aplica as migrações e as outras esperam por ela (42.2 e posteriores). Acompanhe o progresso no log:

docker compose logs -f api

O log termina essa etapa com Migration process completed successfully, ou com Database is up to date, no migrations needed quando a versão principal não mudou. Se uma migração falhar, o Notifuse não inicia, e o log indica qual foi: migration failed for version ….

Verificar a versão

Entre e abra a lista de workspaces. O rodapé mostra a versão em execução, como Notifuse v44.0. O menu da conta também mostra.

Na linha de comando, o arquivo de configuração do console traz a versão:

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

Depois, verifique se https://emails.yourcompany.com/healthz responde {"status":"ok"} e abra um workspace para conferir os seus dados.

Reverter

O Notifuse registra no banco de dados apenas a versão principal, e não tem migrações de reversão.

Dentro da mesma versão principal (da 44.1 de volta para a 44.0, por exemplo), defina a versão anterior em NOTIFUSE_VERSION e rode docker compose up -d. O Notifuse inicia no mesmo banco de dados.

Entre versões principais, a versão mais antiga se recusa a iniciar num banco de dados que a mais nova migrou. O log diz database is at version 44, this build is version 43 - refusing to start. Para voltar:

  1. Pare a stack com docker compose down.
  2. Defina a versão anterior em NOTIFUSE_VERSION ou coloque de volta o compose.yaml dela.
  3. Restaure o backup feito antes da atualização num banco de dados vazio, como mostra Restaurar, com a SECRET_KEY usada quando o backup foi feito.

Tudo o que foi gravado depois do backup se perde.

Quando a atualização foi a da 44.0, que também move o PostgreSQL para o 18, use a cópia que o compose.yaml guarda: Reverter recoloca os dados do PostgreSQL 17 como estavam antes da atualização, com o compose.yaml da versão anterior.

Atualizar o PostgreSQL

A versão 44.0 move o compose.yaml do PostgreSQL 17 para o 18, e o primeiro docker compose up -d com ela também atualiza o banco de dados. Atualizar o PostgreSQL explica o que acontece, quanto espaço em disco é preciso, como verificar e como reverter.