Installationsanweisungen für lokale Bereitstellung
Einleitung
Diese Anleitung behandelt die Docker-basierte Installation vor Ort von Axe Auditor Version 2.25.0.
Medien
Die Medien finden Sie auf dem SFTP-Server.
- Installationsdatei:
axeauditor-docker-on-prem-installer-2.25.0.tar.gz - SSL-Zertifikate: Sollten im PEM-Format vorliegen.
Sicherung
Erstellen Sie vor dem Fortfahren eine vollständige Sicherung des Servers. Diese Sicherung kann verwendet werden, um das System im Falle von Problemen während oder nach der Installation wiederherzustellen.
Hinweis: Wir empfehlen dringend, erst nach Abschluss einer vollständigen Serversicherung 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 worden sein
Medien einrichten
- Herunterladen
axeauditor-docker-on-prem-installer-2.25.0.tar.gz - 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- Bennen Sie Ihre Zertifikatsdateien um zu:
nginx.crtnginx.key
Keycloak-Instanz
Dieses Installationsprogramm erfordert eine externe Keycloak-Einrichtung. 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/.envDatenbank-Migration
- Navigieren Sie zum DB-Ordner
- 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 prü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 wählen Sie Ihren Client aus
- Gehen Sie zum **Installation** -Tab
- Wählen Sie **Keycloak OIDC JSON**
- Kopieren und speichern Sie den Wert für die spätere Verwendung
Einrichten eines neuen Auditor-Clients
- Besuchen Sie die URL zur 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 Anmeldedaten des Realm-Admins ein
Einstellung für den Testlauf teilen aktivieren
- Gehen Sie zu den **Admin-Einstellungen** -Seite
- Stellen Sie sicher, dass **Teilen des Testlaufs aktivieren** standardmäßig **deaktiviert ist**
(sofern nicht anders vom Kunden angegeben)
Aktualisierung der axe Core-Version & des Barrierefreiheitsstandards
- Aktualisieren Sie die **axe-core-Version** auf die **aktuell empfohlene**
- Stellen Sie den **Standard-Barrierefreiheitsstandard** auf **WCAG 2.1 Level AA**
- Wählen Sie **alle Barrierefreiheitsstandards**
Barrierefreiheitsbewertung anzeigen
- Sollte **aktiviert sein** oder **nach Kundenwunsch**
Einstellungen für axe-Berichte aktualisieren
Wenn **axe Reports** wurde während der Installation aktiviert:
- Setzen Sie die Option **Update axe Reports** auf:
System Administrator only
Überprüfung durch Qualitätssicherung und Fachexperten
- Öffnen Sie die URL des Axe Auditor-Servers
- Überprüfen Sie die Fußzeile der Anwendung auf die Version:
2.25.0 - Führen Sie eine grundlegende Überprüfung der Benutzeroberfläche durch
- Fordern Sie das Qualitätssicherungsteam auf, eine grundlegende Überprüfung durchzuführen
Löschen des Installer-Ordners (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