Atualizações

Saber quando sai uma versão

A procura de atualizações está desativada por predefinição, como todas as ligações à Internet. Ative-a em Configurações › Plataforma › Geral › Ligações › Procurar atualizações. Apenas lê as tags das versões publicadas: nada sobre a instância é enviado.

Quando está ativada:

• o rodapé da barra lateral mostra Atualização disponível: … quando sai uma versão mais recente;
• Configurações › Plataforma › Atualização lista as versões mais recentes com O que traz;
• a verificação é executada sozinha a cada seis horas; Procurar atualizações na página Atualização executa-a de imediato e notifica-o do resultado.

O separador Versão mostra a Versão atual, o Canal, a Última versão e o estado do Atualizador. O separador Notas de versão lista todas as versões publicadas, da mais recente para a mais antiga, com o que cada uma traz e o que há a fazer manualmente, se for o caso.

Atualizar a partir das configurações

Isto requer o serviço updater da stack de produção (a página mostra Atualizador: Em execução) e a procura de atualizações ativada.

1. Abra Configurações › Plataforma › Atualização. Em Atualizações disponíveis, leia o que a versão traz.

2. Clique em Atualizar para a … e confirme com Atualizar.

3. A página acompanha as etapas: Cópia de segurança (a base de dados é guardada na pasta de cópias de segurança da instalação), Transferência, Reinício, Verificação. O Auditix fica indisponível um ou dois minutos enquanto os seus serviços reiniciam e, depois, a página recarrega sozinha.

Se a nova versão não arrancar, a anterior volta sozinha. Uma versão pode também exigir uma alteração ao compose.yaml: as suas notas de versão indicam-no, e a alteração é aplicada manualmente (consulte as notas de atualização).

A forma como o atualizador reinicia os serviços depende de AUDITIX_VERSION no .env:

• latest (qualquer instalação, incluindo Portainer): a versão escolhida passa a ser latest no anfitrião e o atualizador recria nela os contentores do Auditix. A stack continua a indicar latest: nada a alterar no Portainer.
• Uma versão fixa (vX.Y.Z), com a pasta de instalação montada em /install: o atualizador define a nova versão no .env e, em seguida, descarrega as imagens e reinicia os serviços.

Versões de desenvolvimento

Quando a licença inclui Versões de desenvolvimento, o Canal da página Atualização oferece Produção (as versões publicadas, por predefinição) e Desenvolvimento (a versão de desenvolvimento mais recente, à frente das versões publicadas). As versões de desenvolvimento podem conter trabalho inacabado, e as suas alterações à base de dados podem anteceder a próxima versão: o regresso a Produção aguarda uma versão mais recente do que a instalada. Reserve-as para instâncias de teste.

Atualizar manualmente

Sem o serviço updater, ou se preferir:

Versão fixa

Defina a nova versão no .env e, em seguida, descarregue as imagens e reinicie:

.env

AUDITIX_VERSION=v0.13.0

docker compose pull
docker compose up -d
docker image prune -f

latest

Mantenha AUDITIX_VERSION=latest e volte a descarregar as imagens:

docker compose pull
docker compose up -d
docker image prune -f

O backend aplica ele próprio as alterações à base de dados no arranque, a partir de qualquer versão anterior. Faça primeiro uma cópia de segurança da base de dados (consulte Cópia de segurança).

Para reverter, defina a versão anterior e execute os mesmos comandos. As alterações à base de dados só avançam: ao reverter para além de uma alteração à base de dados, restaure a cópia de segurança feita antes da atualização.

Nota

As tags das versões começam por v (v0.13.0). As tags sem v das versões até à 0.4.0 já não existem.

Notas de atualização

Alterações a aplicar manualmente ao compose.yaml, consoante a versão a partir da qual instalou:

• Instalado antes da 0.11.1: acrescente cookie_name auditix_live às MERCURE_EXTRA_DIRECTIVES do serviço mercure. Sem isso, os navegadores recebem as atualizações em tempo real através de um relé mais lento e registam um pedido /.well-known/mercure recusado.

  mercure:
    environment:
      MERCURE_EXTRA_DIRECTIVES: |
        resource_identifier http://mercure/.well-known/mercure
        cookie_name auditix_live
        transport bolt {
          path /data/mercure.db
          size 1000
          cleanup_frequency 0.3
        }
        heartbeat 15s

• 0.6 ou anterior: remova o serviço worker, acrescente o serviço orchestrator e remova o contentor deixado pelo serviço worker (docker rm -f <project>-worker-1; com o Portainer: Containers).

• 0.2 ou anterior: acrescente o bloco x-logging e o logging de cada serviço; os serviços gateway, rabbitmq, mercure, developer e logs e os seus volumes; MESSENGER_TRANSPORT_DSN, GATEWAY_SECRET, RABBITMQ_PASSWORD e MERCURE_JWT_SECRET (openssl rand -hex 32), como no ficheiro compose atual. O gateway publica agora as portas: remova as do frontend e, se tiver um proxy inverso, aponte-o para a porta HTTP do gateway.