On-premises Installation Instructions
Not for use with personal data
Introduction
This guide covers the Docker-based on-prem installation of Axe Auditor version 2.25.0.
Media
You can find the media on the SFTP server.
- Installer File:
axeauditor-docker-on-prem-installer-2.25.0.tar.gz
- SSL Certificates: Should be in PEM format.
Backup
Before proceeding, take a full snapshot of the server. This backup can be used to restore the system in case of any issues during or after the installation.
Note: We strongly recommend that you only move forward after completing a full server backup.
Prerequisites
Ensure the following are available and configured:
- Docker Engine
- Docker Compose / Podman Compose
psql
clientCreateSSOCustomers.py
script should have been executed- Database users
assure
andassure_owner
should exist - Target database should be created
Setting up the Media
- Download
axeauditor-docker-on-prem-installer-2.25.0.tar.gz
- Navigate to the download directory
- Extract the archive:
tar -xzf axeauditor-docker-on-prem-installer-2.25.0.tar.gz
SSL Certificates
- Ensure the SSL directory exists:
ls axeauditor-docker/volumes/nginx/
- If it does not exist, create it:
mkdir -p axeauditor-docker/volumes/nginx/ssl
- Copy your certificates to:
axeauditor-docker/volumes/nginx/ssl
- Rename your certificate files to:
nginx.crt
nginx.key
Keycloak Instance
This installer requires an external Keycloak setup. Ensure you have the following information:
- URL: e.g.,
https://auth.deque.com
- Realm: e.g.,
axe
- Client ID
- Group ID
- Client Secret
Installation
Axe Report Configuration
Edit the .env
file:
vi axeauditor-docker/.env
Database Migration
- Navigate to the DB folder
- Edit
auditor_db_deploy.sh
to set the correct variables
(Note: DB user must be a superuser) - Run the script:
./auditor_db_deploy.sh
Load Docker Images
docker load -i resources/axeauditor-2.25.0-ironbank-images.tar
Start Docker Containers
cd axeauditor-docker/
docker compose up -d
Check Logs
docker logs -ft axeauditor-docker-axeauditor-1
Look for the line:
Starting axe Auditor…
Once visible, you may proceed with the remaining steps.
OIDC Token
- Visit the auth URL: e.g.,
https://auth.deque.com
- Navigate to Clients → search and select your client
- Go to the Installation tab
- Select Keycloak OIDC JSON
- Copy and save the value for later use
Setting up a New Auditor Client
- Visit the system client setup URL:
e.g.,docker-fi-215.dequeindiadev.com/system/client
- Paste the Keycloak OIDC JSON from the previous step
- Enter the realm admin credentials
Enable Share Test Run Setting
- Go to the Admin Settings page
- Ensure Enable Share Test Run is unchecked by default
(unless specified by the customer)
Updating axe Core Version & Accessibility Standard
- Update the axe-core version to the latest recommended
- Set Default Accessibility Standard to WCAG 2.1 Level AA
- Select all Accessibility Standards
Show Accessibility Score Card
- Should be checked or as per customer preference
Update axe Reports Settings
If axe Reports was enabled during install:
- Set Update axe Reports option to:
System Administrator only
Sanity Check by QA and SMEs
- Browse to the Axe Auditor server URL
- Check the application footer for version:
2.25.0
- Perform a basic UI verification
- Request QA team to perform a sanity check
Delete the Installer Folder (Recommendation)
After installation, it's recommended to delete the installer archive and extracted files:
rm -f axeauditor-docker-on-prem-installer-2.25.0.tar.gz