Anleitungen 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

Einführung

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

Sicherung

Bevor Sie fortfahren, erstellen Sie einen vollständigen Snapshot 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

Einrichtung der Medien

  1. Herunterladen axeauditor-docker-on-prem-installer-2.25.0.tar.gz
  2. In das Download-Verzeichnis wechseln
  3. Archiv extrahieren:
tar -xzf axeauditor-docker-on-prem-installer-2.25.0.tar.gz

SSL-Zertifikate

  1. Stellen Sie sicher, dass das SSL-Verzeichnis existiert:
ls axeauditor-docker/volumes/nginx/
  1. Falls es nicht existiert, erstellen Sie es:
mkdir -p axeauditor-docker/volumes/nginx/ssl
  1. Kopieren Sie Ihre Zertifikate nach:
axeauditor-docker/volumes/nginx/ssl
  1. Benennen Sie Ihre Zertifikatdateien um in:
  • nginx.crt
  • nginx.key

Keycloak-Instanz

Dieses Installationsprogramm erfordert 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 Secret

Installation

Axe-Berichtskonfiguration

Bearbeiten Sie die .env Datei:

vi axeauditor-docker/.env

Datenbankmigration

  1. Zum DB-Verzeichnis navigieren
  2. Bearbeiten Sie auditor_db_deploy.sh um die richtigen Variablen festzulegen
    (Hinweis: DB-Benutzer muss ein Superuser sein)
  3. 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 sichtbar, können Sie mit den restlichen Schritten fortfahren.

OIDC-Token

  1. Besuchen Sie die Auth-URL: z.B., https://auth.deque.com
  2. Gehen Sie zu **Clients** → suchen und wählen Sie Ihren Client aus
  3. Gehen Sie zum **Installation** Tab
  4. Wählen Sie **Keycloak OIDC JSON**
  5. Kopieren und speichern Sie den Wert für späteren Gebrauch

Einrichten eines neuen Auditor-Clients

  1. Besuchen Sie die System-Client-Setup-URL:
    z.B., docker-fi-215.dequeindiadev.com/system/client
  2. Fügen Sie das Keycloak OIDC JSON aus dem vorherigen Schritt ein
  3. Geben Sie die Administrator-Anmeldedaten des Realms ein

Einstellen der Share-Testlauf-Einstellungen

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

Aktualisierung 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**

Barrierefreiheitsergebnisbogen anzeigen

  • Sollte **aktiviert** sein oder **nach Kundenwunsch**

Aktualisieren der axe Berichte-Einstellungen

Falls **axe Reports** wurde während der Installation aktiviert:

  • Stellen Sie die Option **Update axe Reports** ein auf:
    System Administrator only

Kontrollprüfung durch QA und SMEs

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