Installationsanleitung für lokale Installation
Einführung
Diese Anleitung behandelt die Docker-basierte lokale Installation von Axe Auditor Version 2.25.0.
Medien
Sie finden die Medien auf dem SFTP-Server.
- Installationsdatei:
axeauditor-docker-on-prem-installer-2.25.0.tar.gz - SSL-Zertifikate: Sollten im PEM-Format vorliegen.
Backup
Vor dem Fortfahren, erstellen Sie einen vollständigen Snapshot des Servers. Dieses Backup kann verwendet werden, um das System im Falle von Problemen während oder nach der Installation wiederherzustellen.
Hinweis: Wir empfehlen dringend, erst nach Abschluss eines vollständigen Server-Backups 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
- Herunterladen
axeauditor-docker-on-prem-installer-2.25.0.tar.gz - Gehen Sie zum Download-Verzeichnis
- Archiv entpacken:
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 Zertifikatsdateien um zu:
nginx.crtnginx.key
Keycloak-Instanz
Dieser Installer erfordert ein externes Keycloak-Setup. Stellen Sie sicher, dass Sie folgende Informationen haben:
- URL: z.B.,
https://auth.deque.com - Realm: z.B.,
axe - Client-ID
- Gruppen-ID
- Client-Geheimnis
Installation
Konfiguration des Axe-Reports
Bearbeiten Sie die .env Datei:
vi axeauditor-docker/.envDatenbankmigration
- Gehen Sie zum DB-Verzeichnis
- Bearbeiten Sie
auditor_db_deploy.shum die korrekten Variablen einzustellen
(Hinweis: DB-Benutzer muss ein Superuser sein) - 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 überprüfen
docker logs -ft axeauditor-docker-axeauditor-1Suchen Sie nach der Zeile:
Starting axe Auditor…Sobald sie sichtbar ist, können Sie mit den verbleibenden Schritten fortfahren.
OIDC-Token
- Besuchen Sie die Auth-URL: z.B.
https://auth.deque.com - Navigieren Sie zu **Clients** → suchen und Ihren Client auswählen
- Gehen Sie zum **Installation** Tab
- Wählen Sie **Keycloak OIDC JSON**
- Kopieren und speichern Sie den Wert zur späteren Verwendung
Einrichten eines neuen Auditor-Clients
- Besuchen Sie die System-Client-Setup-URL:
z.B.docker-fi-215.dequeindiadev.com/system/client - Fügen Sie das Keycloak OIDC JSON aus dem vorherigen Schritt ein
- Geben Sie die Anmeldedaten des Realm-Administrators ein
Testlauf-Einstellung teilen aktivieren
- Gehen Sie zu den **Admin-Einstellungen** Seite
- Stellen Sie sicher, dass **Testlauf teilen aktivieren** standardmäßig **deaktiviert**
(es sei denn, vom Kunden anders angegeben)
Aktualisieren der axe-Core-Version & des Barrierefreiheitsstandards
- Aktualisieren Sie die **axe-core Version** auf die **neueste empfohlene**
- Stellen Sie den **Standard-Barrierefreiheitsstandard** auf **WCAG 2.1 Level AA**
- Wählen Sie **alle Barrierefreiheitsstandards**
Barrierefreiheits-Punktekarte anzeigen
- Sollte **markiert** oder **nach Kundenwunsch**
Axe-Berichtseinstellungen aktualisieren
Falls **axe Reports** wurde während der Installation aktiviert:
- Setzen Sie die **Option "axe Reports aktualisieren"** auf:
System Administrator only
Überprüfung durch QA und Fachexperten
- Rufen Sie die URL des Axe Auditor-Servers auf
- Überprüfen Sie die Fußzeile der Anwendung auf die Version:
2.25.0 - Führen Sie eine grundlegende UI-Überprüfung durch
- Bitten Sie das QA-Team, eine Überprü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