Instruções de Instalação On-premises

Introdução

Este guia cobre a instalação on-prem baseada em Docker da versão 2.25.0 do Axe Auditor.

Mídia

Você pode encontrar a mídia no servidor SFTP.

• Arquivo Instalador: axeauditor-docker-on-prem-installer-2.25.0.tar.gz
• Certificados SSL: Deve estar no formato PEM.

Backup

Antes de prosseguir, faça um snapshot completo do servidor. Este backup pode ser usado para restaurar o sistema em caso de quaisquer problemas durante ou após a instalação.

Nota: Recomendamos fortemente que você só prossiga após completar um backup completo do servidor.

Pré-requisitos

Certifique-se de que os seguintes itens estejam disponíveis e configurados:

• Docker Engine
• Docker Compose / Podman Compose
• psql cliente
• CreateSSOCustomers.py script deveria ter sido executado
• Os usuários do banco de dados assure e assure_owner devem existir
• O banco de dados alvo deve ser criado

Configuração da Mídia

1. Baixar axeauditor-docker-on-prem-installer-2.25.0.tar.gz
2. Navegue até o diretório de downloads
3. Extraia o arquivo:

tar -xzf axeauditor-docker-on-prem-installer-2.25.0.tar.gz

Certificados SSL

1. Certifique-se de que o diretório SSL exista:

ls axeauditor-docker/volumes/nginx/

2. Se não existir, crie-o:

mkdir -p axeauditor-docker/volumes/nginx/ssl

3. Copie seus certificados para:

axeauditor-docker/volumes/nginx/ssl

4. Renomeie seus arquivos de certificado para:

• nginx.crt
• nginx.key

Instância Keycloak

Este instalador requer um configuração do Keycloak externa. Certifique-se de ter as seguintes informações:

• URL: por exemplo, https://auth.deque.com
• Realm: por exemplo, axe
• ID do Cliente
• ID do Grupo
• Segredo do Cliente

Instalação

Configuração do Relatório Axe

Edite o arquivo .env:

vi axeauditor-docker/.env

Migração de Banco de Dados

1. Navegue até a pasta do DB
2. Edite auditor_db_deploy.sh para definir as variáveis corretas
   (Nota: O usuário do BD deve ser um superusuário)
3. Execute o script:

./auditor_db_deploy.sh

Carregar Imagens Docker

docker load -i resources/axeauditor-2.25.0-ironbank-images.tar

Iniciar Containers Docker

cd axeauditor-docker/
docker compose up -d

Verificar Logs

docker logs -ft axeauditor-docker-axeauditor-1

Procure a linha:

Starting axe Auditor…

Assim que estiver visível, você pode prosseguir com as etapas restantes.

Token OIDC

1. Visite a URL de autenticação: por exemplo, https://auth.deque.com
2. Navegue para Clientes → pesquise e selecione seu cliente
3. Vá para a aba Instalação
4. Selecione Keycloak OIDC JSON
5. Copie e salve o valor para uso posterior

Configurando um Novo Cliente Auditor

1. Visite a URL de configuração do cliente do sistema:
   por exemplo, docker-fi-215.dequeindiadev.com/system/client
2. Cole o Keycloak OIDC JSON do passo anterior
3. Insira as credenciais de administrador do reino

Habilitar Configuração de Compartilhamento de Test Run

• Vá para a página Configurações de Admin
• Certifique-se de que Habilitar Compartilhamento de Test Run está desmarcado por padrão
  (a menos que especificado pelo cliente)

Atualizando Versão do axe Core e Padrão de Acessibilidade

• Atualize o versão do axe-core para mais recente recomendada
• Defina Padrão de Acessibilidade Padrão para WCAG 2.1 Nível AA
• Selecione todos os Padrões de Acessibilidade

Mostrar Cartão de Pontuação de Acessibilidade

• Deve ser marcado ou segundo a preferência do cliente

Atualizar Configurações do Relatório axe

Se axe Reports foi habilitado durante a instalação:

• Defina a opção Atualizar axe Reports para:
  System Administrator only

Verificação de Sanidade por QA e SMEs

1. Navegue para o URL do servidor do Axe Auditor
2. Verifique o rodapé da aplicação para a versão: 2.25.0
3. Realize uma verificação básica da interface do usuário
4. Solicite à equipe de QA que realize uma verificação de sanidade

Excluir a Pasta do Instalador (Recomendação)

Após a instalação, é recomendado excluir o arquivo de instalação e os arquivos extraídos:

rm -f axeauditor-docker-on-prem-installer-2.25.0.tar.gz