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

Introdução

Este guia abrange a instalação on-premises baseada em Docker do Axe Auditor versão 2.25.0.

Mídia

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

• Arquivo de 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 problemas durante ou após a instalação.

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

Pré-requisitos

Garanta que o seguinte esteja disponível e configurado:

• Docker Engine
• Docker Compose / Podman Compose
• psql cliente
• CreateSSOCustomers.py script 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

Configurando a Mídia

1. Baixar axeauditor-docker-on-prem-installer-2.25.0.tar.gz
2. Navegue para 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 Keycloak

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

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

Instalação

Configuração do Relatório Axe

Edite o .env arquivo:

vi axeauditor-docker/.env

Migração de Banco de Dados

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

./auditor_db_deploy.sh

Carregar Imagens do Docker

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

Iniciar Contêineres do 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** → procure e selecione seu cliente
3. Vá para a **Instalação** aba
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 JSON do Keycloak OIDC do passo anterior
3. Insira as credenciais de administrador do domínio

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

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

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

• Atualize a **versão do axe-core** para a **mais recente recomendada**
• Defina o **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

• Deveria estar **marcado** ou **de acordo com a preferência do cliente**

Atualizar Configurações de Relatórios do axe

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

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

Verificação de Sanidade por QA e Especialistas

1. Navegue para o URL do servidor 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 para realizar uma verificação de sanidade

Excluir a Pasta do Instalador (Recomendação)

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

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