Anweisungen zur Installation vor Ort

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Not for use with personal data

Einleitung

Dieses Handbuch behandelt die Docker-basierte Installation vor Ort 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.

Sicherung

Bevor Sie fortfahren, erstellen Sie ein vollständiges Abbild 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
psql Client
CreateSSOCustomers.py Skript sollte ausgeführt worden sein
Datenbankbenutzer assure und assure_owner sollten existieren
Zieldatenbank sollte erstellt werden

Einrichten der Medien

Herunterladen axeauditor-docker-on-prem-installer-2.25.0.tar.gz
Zum Download-Verzeichnis navigieren
Archiv extrahieren:

tar -xzf axeauditor-docker-on-prem-installer-2.25.0.tar.gz

SSL-Zertifikate

Stellen Sie sicher, dass das SSL-Verzeichnis existiert:

ls axeauditor-docker/volumes/nginx/

Wenn es nicht existiert, erstellen Sie es:

mkdir -p axeauditor-docker/volumes/nginx/ssl

Kopieren Sie Ihre Zertifikate nach:

axeauditor-docker/volumes/nginx/ssl

Benen Sie Ihre Zertifikatdateien um in:

nginx.crt
nginx.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-Secret

Installation

Axe-Berichtskonfiguration

Bearbeiten Sie die .env Datei:

vi axeauditor-docker/.env

Datenbankmigration

Zum DB-Ordner navigieren
Bearbeiten Sie auditor_db_deploy.sh um die richtigen Variablen einzustellen
(Hinweis: DB-Benutzer muss ein Superuser sein)
Führen Sie das Skript aus:

./auditor_db_deploy.sh

Docker-Images laden

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

Docker-Container starten

cd axeauditor-docker/
docker compose up -d

Protokolle überprüfen

docker logs -ft axeauditor-docker-axeauditor-1

Suchen Sie nach der Zeile:

Starting axe Auditor…

Sobald sie sichtbar ist, 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**
Kopieren und speichern Sie den Wert für die spätere Verwendung

Einen neuen Audit-Client einrichten

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 Realm-Admin-Anmeldedaten ein

Teilen-Testlauf-Einstellungen aktivieren

Gehen Sie zu den **Admin-Einstellungen** Seite
Stellen Sie sicher, dass **Teilen-Testlauf aktivieren** standardmäßig **deaktiviert**
(sofern nicht vom Kunden angegeben)

Aktualisieren der axe-Core-Version & Barrierefreiheitsstandard

Aktualisieren Sie die **axe-core-Version** auf die **neueste empfohlene**
Setzen Sie den **Standard für Barrierefreiheit** auf **WCAG 2.1 Level AA**
Wählen Sie **alle Barrierefreiheitsstandards**

Barrierefreiheits-Scorekarte anzeigen

Sollte **aktiviert** oder **je nach Kundenwunsch**

Einstellungen für axe-Berichte aktualisieren

Falls **Axe-Berichte** wurde während der Installation aktiviert:

Stellen Sie die Option **Axe-Berichte aktualisieren** ein auf:
System Administrator only

Plausibilitätsprüfung durch QA und Fachexperten

Navigieren Sie zur URL des Axe Auditor-Servers
Überprüfen Sie die Fußzeile der Anwendung auf Version: 2.25.0
Führen Sie eine grundlegende UI-Überprüfung durch
Bitten Sie das QA-Team, eine Plausibilitätsprü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