Instruções de Instalação Local

Introdução

Este guia abrange a instalação local baseada em Docker da versão 2.25.0 do Axe Auditor.

Mídia

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

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

Backup

Antes de prosseguir, faça uma captura completa do servidor. Este backup pode ser usado para restaurar o sistema em caso de qualquer problema durante ou após a instalação.

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

Pré-requisitos

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

• Motor Docker
• Docker Compose / Podman Compose
• Cliente psql
• O script CreateSSOCustomers.py deve ter sido executado
• Usuários do banco de dados assure e assure_owner devem existir
• O banco de dados de destino 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 download
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 do Keycloak

Este instalador requer um configuração externa do Keycloak. Certifique-se de ter a seguinte informação:

• 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 do Banco de Dados

1. Navegue até a pasta DB
2. Edite auditor_db_deploy.sh para definir as variáveis corretas
   (Nota: o usuário do BD deve ser 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 Contêineres Docker

cd axeauditor-docker/
docker compose up -d

Verificar Logs

docker logs -ft axeauditor-docker-axeauditor-1

Procure pela linha:

Starting axe Auditor…

Uma vez visível, você pode prosseguir com os passos restantes.

Token OIDC

1. Visite a URL de autenticação: por exemplo, https://auth.deque.com
2. Navegue até 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 futuro

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 domínio

Habilitar Configuração de Compartilhamento de Execução de Testes

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

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

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

Mostrar Cartão de Pontuação de Acessibilidade

• Deve ser verificado ou conforme preferência do cliente

Atualizar Configurações de Relatórios do axe

Se Relatórios do axe foi habilitado durante a instalação:

• Defina a opção Atualizar Relatórios do axe para:
  System Administrator only

Verificação de Sanidade por QA e SMEs

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

Excluir a Pasta do Instalador (Recomendação)

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

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