Installation - Magento

Um DockRay in Magento zu nutzen, erstellen Sie zunächst ein Projekt in DockRay, kopieren Sie dessen Token und generieren Sie einen privaten API-Schlüssel. Das Token identifiziert das Projekt, während der private Schlüssel zur Authentifizierung Ihrer Magento-Installation dient.

Sie haben noch kein Projekt? Lesen Sie die Anleitung Konto und erstes Projekt erstellen und kehren Sie anschließend zu dieser Dokumentation zurück, um die Integration zu installieren.

Systemanforderungen

Die DockRay-Integration unterstützt Shops mit Magento Open Source oder Adobe Commerce ab Version 2.4.4 sowie Mage-OS. PHP 8.1 oder höher ist erforderlich.

Das Paket wird über Composer unter dem Namen dockcodes/dock-ray-magento bereitgestellt. Prüfen Sie vor der Installation im entsprechenden Vertriebskanal, ob die neueste Version verfügbar ist.

DockRay in Magento über Composer installieren

Verbinden Sie sich mit dem Server Ihres Shops und wechseln Sie in das Magento-Stammverzeichnis. Führen Sie anschließend die folgenden Befehle aus, um das Paket zu installieren, das Modul zu aktivieren und die Anwendungskonfiguration zu aktualisieren.

composer require dockcodes/dock-ray-magento
bin/magento module:enable DockCodes_DockRay
bin/magento setup:upgrade

# Im Produktionsmodus zusätzlich ausführen:


bin/magento setup:di:compile
bin/magento setup:static-content:deploy

Nach Abschluss der Installation ist das DockRay-Modul im Magento-Administrationsbereich verfügbar. Führen Sie die Befehle in Produktionsumgebungen gemäß dem Bereitstellungsprozess Ihres Shops aus.

Projekt-Token und privaten Schlüssel konfigurieren

Verbinden Sie Ihre Magento-Installation mit dem erstellten DockRay-Projekt. Navigieren Sie im Administrationsbereich zu Shops → Konfiguration → DockRay → Monitoring und geben Sie das Projekt-Token sowie den privaten Schlüssel ein.

Wenn Sie den privaten Schlüssel nicht in der Datenbank speichern möchten, können Sie beide Zugangsdaten mit den folgenden Befehlen in der Umgebungskonfiguration hinterlegen:

bin/magento config:set --lock-env dockray/connection/token IHR_PROJEKT_TOKEN
bin/magento config:set --lock-env dockray/connection/private_key IHR_PRIVATER_SCHLUESSEL

Ersetzen Sie IHR_PROJEKT_TOKEN durch das Token Ihres Projekts und IHR_PRIVATER_SCHLUESSEL durch Ihren generierten API-Schlüssel. Wenn Sie Werte mit der Option --lock-env speichern, werden die entsprechenden Felder im Administrationsbereich gesperrt und verwenden die in der Umgebungskonfiguration hinterlegten Werte.

Integration im Magento-Administrationsbereich überprüfen

Öffnen Sie nach dem Speichern der Zugangsdaten den Bereich DockRay → Overview. Dort sehen Sie den Verbindungsstatus, die verfügbaren Modul-Funktionen und Informationen zum letzten Schwachstellenbericht. Sie können außerdem ein Testereignis senden, um die korrekte Funktion der Integration zu überprüfen.

Um die Integrationseinstellungen zu verwalten, wählen Sie im Magento-Administrationsmenü DockRay → Settings. Unter Overview können Sie den Integrationsstatus prüfen, während Sie unter Settings die Konfiguration verwalten.

Überprüfung nach der Installation

Vergewissern Sie sich vor der Aktivierung des Monitorings, dass das Token und der private Schlüssel zum selben DockRay-Projekt gehören. Stellen Sie außerdem sicher, dass der private Schlüssel weder im Repository gespeichert noch in öffentlich zugänglichem Anwendungscode offengelegt wurde.

Konfigurieren Sie anschließend die Umgebung, legen Sie den Umfang der Berichterstattung fest und senden Sie ein Testereignis. Sobald Sie bestätigt haben, dass die Integration korrekt funktioniert, können Sie die Berichterstattung für den Produktionsbetrieb aktivieren.

Wie geht es weiter?

Lesen Sie nach der Installation die Anleitung zur Überwachung von Anwendungsschwachstellen mit DockRay, um Prüfungen auf bekannte Sicherheitslücken zu konfigurieren und Berichte zu Ihren Magento-Komponenten einzusehen.