Installationsanleitung für lokale Installation

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

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
  • psql Client
  • CreateSSOCustomers.py Skript sollte ausgeführt worden sein
  • Datenbankbenutzer assure und assure_owner sollten existieren
  • Zieldatenbank sollte erstellt werden

Einrichten der Medien

  1. Herunterladen axeauditor-docker-on-prem-installer-2.25.0.tar.gz
  2. Gehen Sie zum Download-Verzeichnis
  3. Archiv entpacken:
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 Zertifikatsdateien um zu:
  • nginx.crt
  • nginx.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/.env

Datenbankmigration

  1. Gehen Sie zum DB-Verzeichnis
  2. Bearbeiten Sie auditor_db_deploy.sh um die korrekten Variablen einzustellen
    (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 sie sichtbar ist, können Sie mit den verbleibenden Schritten fortfahren.

OIDC-Token

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

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

  1. Rufen Sie die URL des Axe Auditor-Servers auf
  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 Ü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