Anleitungen zur Installation vor Ort
Einleitung
Diese Anleitung behandelt die Docker-basierte Installation von Axe Auditor Version 2.25.0 für On-Premise.
Medien
Sie finden die Medien auf dem SFTP-Server.
- Installationsdatei:
axeauditor-docker-on-prem-installer-2.25.0.tar.gz - SSL-Zertifikate: Sollte im PEM-Format sein.
Backup
Vor dem Fortfahren erstellen Sie eine vollständige Momentaufnahme des Servers. Dieses Backup kann verwendet werden, um das System bei auftretenden Problemen während oder nach der Installation wiederherzustellen.
Hinweis: Wir empfehlen dringend, erst nach Abschluss einer vollständigen Sicherung des Servers fortzufahren.
Voraussetzungen
Stellen Sie sicher, dass Folgendes verfügbar und konfiguriert ist:
- Docker-Engine
- Docker Compose / Podman Compose
psqlClientCreateSSOCustomers.pySkript sollte ausgeführt worden sein- Datenbankbenutzer
assureundassure_ownersollten existieren - Zieldatenbank sollte erstellt werden
Einrichten der Medien
- Laden Sie
axeauditor-docker-on-prem-installer-2.25.0.tar.gzherunter - Navigieren Sie zum Download-Verzeichnis
- Archiv extrahieren:
tar -xzf axeauditor-docker-on-prem-installer-2.25.0.tar.gzSSL-Zertifikate
- Stellen Sie sicher, dass das SSL-Verzeichnis existiert:
ls axeauditor-docker/volumes/nginx/- Falls es nicht existiert, erstellen Sie es:
mkdir -p axeauditor-docker/volumes/nginx/ssl- Kopieren Sie Ihre Zertifikate nach:
axeauditor-docker/volumes/nginx/ssl- Benennen Sie Ihre Zertifikatdateien um zu:
nginx.crtnginx.key
Keycloak-Instanz
Dieser Installer benötigt eine externe Keycloak-Konfiguration. Stellen Sie sicher, dass Sie die folgenden Informationen haben:
- URL: z. B.
https://auth.deque.com - Realm: z. B.
axe - Client-ID
- Gruppen-ID
- Client-Geheimnis
Installation
Axe-Report-Konfiguration
Bearbeiten Sie die .env-Datei:
vi axeauditor-docker/.envDatenbankmigration
- Navigieren Sie zum DB-Verzeichnis
- Bearbeiten Sie
auditor_db_deploy.sh, um die korrekten Variablen
(Hinweis: Der DB-Benutzer muss ein Superuser sein) festzulegen - Führen Sie das Skript aus:
./auditor_db_deploy.shDocker-Images laden
docker load -i resources/axeauditor-2.25.0-ironbank-images.tarDocker-Container starten
cd axeauditor-docker/
docker compose up -dProtokolle prüfen
docker logs -ft axeauditor-docker-axeauditor-1Suchen Sie nach der Zeile:
Starting axe Auditor…Sobald sichtbar, können Sie mit den restlichen Schritten fortfahren.
OIDC-Token
- Besuchen Sie die Auth-URL: z.B.
https://auth.deque.com - Navigieren Sie zu Clients → suchen und wählen Sie Ihren Client aus
- Gehen Sie zum Installation-Tab
- Wählen Sie Keycloak OIDC JSON aus
- Kopieren und speichern Sie den Wert für die spätere Verwendung
Einrichten eines neuen Auditor-Clients
- Besuchen Sie die URL für die System-Client-Einrichtung:
z.B.docker-fi-215.dequeindiadev.com/system/client - Fügen Sie das Keycloak OIDC JSON aus dem vorherigen Schritt ein
- Geben Sie die Administratoranmeldedaten des Realms ein
Einstellung 'Teilen von Testruns' aktivieren
- Gehen Sie zur Admin-Einstellungen-Seite
- Stellen Sie sicher, dass Teilen von Testruns aktivieren standardmäßig deaktiviert
(sofern nicht vom Kunden angegeben) ist
Aktualisierung der axe-Core-Version & Barrierefreiheitsstandard
- Aktualisieren Sie das axe-core-Version auf das neueste empfohlene
- Setzen Sie Standard-Barrierefreiheitsstandard auf WCAG 2.1 Level AA
- Wählen Sie alle Barrierefreiheitsstandards aus
Barrierefreiheitsbewertungsbogen anzeigen
- Sollte aktiviert oder nach Kundenwunsch sein
Aktualisierung der axe-Berichtseinstellungen
Falls axe-Berichte während der Installation aktiviert war:
- Setzen Sie die axe-Berichte aktualisieren-Option auf:
System Administrator only
Prüfung durch QA und Fachexperten
- Navigieren Sie zur Axe Auditor-Server-URL
- Überprüfen Sie die Fußzeile der Anwendung auf die Version:
2.25.0 - Führen Sie eine grundlegende UI-Überprüfung durch
- Fordern Sie das QA-Team auf, eine Prüfung durchzuführen
Löschen des Installationsordners (Empfehlung)
Nach der Installation wird empfohlen, das Installationsarchiv und die extrahierten Dateien zu löschen:
rm -f axeauditor-docker-on-prem-installer-2.25.0.tar.gz