Anweisungen zur lokalen Installation
Einführung
Dieses Handbuch 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: Sollte im PEM-Format sein.
Backup
Bevor Sie fortfahren, erstellen Sie einen vollständigen Schnappschuss 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
Einrichtung der Medien
- Laden Sie
axeauditor-docker-on-prem-installer-2.25.0.tar.gzherunter - Wechseln Sie in das Download-Verzeichnis
- Entpacken Sie das Archiv:
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 nicht vorhanden, 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 in:
nginx.crtnginx.key
Keycloak-Instanz
Dieses Installationsprogramm erfordert ein externes Keycloak-Setup. 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
Installations
Axe-Berichtskonfiguration
Bearbeiten Sie die .env Datei:
vi axeauditor-docker/.envDatenbankmigration
- Wechseln Sie in den DB-Ordner
- Bearbeiten Sie
auditor_db_deploy.sh, um die korrekten Variablen festzulegen
(Hinweis: DB-Benutzer muss ein Superuser sein) - Führen Sie das Skript aus:
./auditor_db_deploy.shDocker-Bilder 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 sichtbar, 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
- Gehen Sie zum Installations Tab
- Wählen Sie Keycloak OIDC JSON
- Kopieren Sie den Wert und speichern Sie ihn für den späteren Gebrauch
Einrichtung 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 Administratoranmeldedaten des Realms ein
Freigabetestlauf-Einstellung aktivieren
- Gehen Sie zur Admin-Einstellungen Seite
- Stellen Sie sicher, dass Freigabetestlauf aktivieren nicht aktiviert ist
(es sei denn, der Kunde hat das festgelegt) ist
Aktualisieren der axe Core-Version und des Barrierefreiheitsstandards
- Aktualisieren Sie die axe-core Version auf die neueste empfohlene
- Setzen Sie standardmäßigen Barrierefreiheitsstandard auf WCAG 2.1 Level AA
- Wählen Sie alle Barrierefreiheitsstandards
Barrierefreiheits-Scorekarte anzeigen
- Sollte aktiviert oder je nach Kundenwunsch sein
Aktualisieren der axe-Berichtseinstellungen
Falls axe Reports während der Installation aktiviert wurde:
- Setzen Sie die Update axe Reports Option auf:
System Administrator only
Prüfung durch QA und Fachexperten
- Navigieren Sie zur URL des Axe Auditor-Servers
- Überprüfen Sie das Anwendungs-Footer auf Version:
2.25.0 - Führen Sie eine grundlegende UI-Verifizierung durch
- Bitten Sie das QA-Team um eine Prüfung
Löschen Sie den Ordner des Installationsprogramms (Empfehlung)
Es wird empfohlen, nach der Installation das Installationsarchiv und die extrahierten Dateien zu löschen:
rm -f axeauditor-docker-on-prem-installer-2.25.0.tar.gz