diff --git a/docs/daux/config.json b/docs/daux/config.json index 9cd4f03..01485eb 100644 --- a/docs/daux/config.json +++ b/docs/daux/config.json @@ -64,6 +64,7 @@ "modulename" : " Google Services", "menutitle" : " Google Services", "modulefolder" : "d3_googleanalytics", + "metadataident" : "d3_googleanalytics", "modcfgident" : "d3_googleanalytics", "composerident" : "d3/googleservices" }, diff --git a/docs/daux/installation/010_Anforderungen/010_Systemanforderungen.md b/docs/daux/installation/010_Anforderungen/010_Systemanforderungen.md index b028833..7f96926 100644 --- a/docs/daux/installation/010_Anforderungen/010_Systemanforderungen.md +++ b/docs/daux/installation/010_Anforderungen/010_Systemanforderungen.md @@ -4,8 +4,13 @@ title: Systemanforderungen * PHP Version * 7.1.x bis 8.0.x -* Shopversionen / -editionen - * OXID eShop Community Edition (CE), Professional Edition (PE) oder Enterprise Edition (EE) in Compilation Version +* Shopeditionen + * OXID eShop Community Edition (CE) + * OXID eShop Professional Edition (PE) + * OXID eShop Enterprise Edition (EE) + * OXID eShop B2B Edition +* Shopversionen + * OXID eShop in Compilation Version * 6.2.x * 6.3.x * Themes diff --git a/docs/daux/installation/020_Neuinstallation/020_Modul_hinzufuegen.md b/docs/daux/installation/020_Neuinstallation/020_Modul_hinzufuegen.md index f024ce8..a239c1a 100644 --- a/docs/daux/installation/020_Neuinstallation/020_Modul_hinzufuegen.md +++ b/docs/daux/installation/020_Neuinstallation/020_Modul_hinzufuegen.md @@ -2,10 +2,14 @@ title: Modul zur Installation hinzufügen --- +### **auf der Kommandozeile** + Führen Sie in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) diesen Befehl aus, um das Modul **{$modulename}** zur Installation hinzuzufügen: ```bash php composer require {$composerident}:^{$moduleversion} --update-no-dev ``` +> [!] Achten Sie darauf, dass Composer für die Installation die selbe PHP-Version verwendet, in der auch Ihr Shop ausgeführt wird. Sie erhalten sonst möglicherweise unpassende Modulpakete. + > [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require). diff --git a/docs/daux/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md b/docs/daux/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md index 02ea797..75c2f3e 100644 --- a/docs/daux/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md +++ b/docs/daux/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md @@ -2,6 +2,18 @@ title: Modul im Shop aktivieren --- +### **im Adminbereich** + Aktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ]. -> [!] **Enterprise Editon**: Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen. \ No newline at end of file +### **oder auf der Kommandozeile** + +Alternativ können Sie die Modulaktivierung auch auf der Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) durchführen. + +```bash +./vendor/bin/oe-console oe:module:activate {$metadataident} +``` + +> [!] **Enterprise Edition**: Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen. + +> [i] **Enterprise Edition**: Zur Aktivierung in einem bestimmten Shopmandanten verwenden Sie das `--shop-id`-Argument (`...oe-console --shop-id 1 oe:module...`) \ No newline at end of file diff --git a/docs/daux/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md b/docs/daux/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md index 636441d..6f55278 100644 --- a/docs/daux/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md +++ b/docs/daux/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md @@ -2,10 +2,20 @@ title: Shopanpassungen installieren --- +### **im Adminbereich** + Direkt nach der Modulaktivierung startet der Assistent, der Sie durch die Shopanpassung führt. Darin können Sie verschiedene Optionen der Installation wählen. Den Installationsassistenten finden Sie auch unter den Menüpunkten [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ]. Bei tiefgreifenden Änderungen an Ihrem Shop (z.B. Hinzufügen weiterer Sprachen oder Mandanten) rufen Sie den Installationsassistenten bitte erneut auf, um dann eventuell notwendige Nacharbeiten für das Modul ausführen zu lassen. -Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen. \ No newline at end of file +Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen. + +### **oder auf der Kommandozeile** + +Der Installationsassistent steht Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3modules_install +``` \ No newline at end of file diff --git a/docs/daux/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md b/docs/daux/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md index fb6a3a2..d845b9b 100644 --- a/docs/daux/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md +++ b/docs/daux/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md @@ -2,8 +2,20 @@ title: TMP-Ordner leeren --- +### **im Adminbereich** + Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ]. Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch. -> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. \ No newline at end of file +### **oder auf der Kommandozeile** + +Alle TMP-leeren-Aktionen stehen Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3cleartmp +``` + +> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. + +> [i] Beim Kommandozeilenaufruf werden Ihnen weitere Optionen gezeigt, mit denen Sie die Aktion gezielt steuern können. \ No newline at end of file diff --git a/docs/daux/installation/020_Neuinstallation/_index.md b/docs/daux/installation/020_Neuinstallation/_index.md index 3c7760a..ea7dc79 100644 --- a/docs/daux/installation/020_Neuinstallation/_index.md +++ b/docs/daux/installation/020_Neuinstallation/_index.md @@ -4,8 +4,13 @@ Title: Schnellstart per Composer ## Schnellstart per Composer +### **auf der Kommandozeile** + ```bash php composer require {$composerident}:^{$moduleversion} --update-no-dev +./vendor/bin/oe-console oe:module:activate {$metadataident} +./vendor/bin/d3modules_install +./vendor/bin/d3cleartmp ``` Detailliertere Angaben zur Installation entnehmen Sie bitte den folgenden Seiten. diff --git a/docs/daux/installation/030_Update/005_Updatedefinition.md b/docs/daux/installation/030_Update/005_Updatedefinition.md index 492cee3..3e3e9f3 100644 --- a/docs/daux/installation/030_Update/005_Updatedefinition.md +++ b/docs/daux/installation/030_Update/005_Updatedefinition.md @@ -2,7 +2,7 @@ title: Wann kann ein Update ausgeführt werden? --- -Die Updatenaweisungen können verwendet werden, wenn dieses Modul schon früher mit Hilfe von Composer installiert wurde. +Die Updateanweisungen können verwendet werden, wenn dieses Modul schon früher mit Hilfe von Composer installiert wurde. Wurde die Installation bisher noch nicht durchgeführt oder die Installation wurde **nicht** über Composer durchgeführt (weil das Modul dies z.B. früher nicht unterstützte), verwenden Sie bitte die Beschreibung unter [Neuinstallation](../020_Neuinstallation/_index.md). \ No newline at end of file diff --git a/docs/daux/installation/030_Update/010_Modul_deaktivieren.md b/docs/daux/installation/030_Update/010_Modul_deaktivieren.md index ba3f82d..4ba4d78 100644 --- a/docs/daux/installation/030_Update/010_Modul_deaktivieren.md +++ b/docs/daux/installation/030_Update/010_Modul_deaktivieren.md @@ -2,4 +2,18 @@ title: Modul deaktivieren --- -Deaktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ]. \ No newline at end of file +### **im Adminbereich** + +Deaktivieren Sie das Modul unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ]. + +### **oder auf der Kommandozeile** + +Alternativ können Sie die Moduldeaktivierung auch über die Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) durchführen. + +```bash +./vendor/bin/oe-console oe:module:deactivate {$metadataident} +``` + +> [!] **Enterprise Edition**: Achten Sie darauf, dass das Modul in allen weiteren Shops (Mall) ebenfalls deaktiviert werden muss. + +> [i] **Enterprise Edition**: Zur Deaktivierung in einem bestimmten Shopmandanten verwenden Sie das `--shop-id`-Argument (`...oe-console --shop-id 1 oe:module...`) \ No newline at end of file diff --git a/docs/daux/installation/030_Update/020_Dateien_erneuern.md b/docs/daux/installation/030_Update/020_Dateien_erneuern.md index d49d840..15504c3 100644 --- a/docs/daux/installation/030_Update/020_Dateien_erneuern.md +++ b/docs/daux/installation/030_Update/020_Dateien_erneuern.md @@ -2,6 +2,8 @@ title: Dateien erneuern --- +### **auf der Kommandozeile** + Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Führen Sie dort diesen Befehl aus: @@ -11,6 +13,6 @@ php composer require {$composerident}:^{$moduleversion} --update-no-dev Im weiteren Ablauf werden Sie gefragt, ob die Moduldateien überschrieben werden sollen. Bestätigen Sie dies für den Eintrag `{$composerident}`. -> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete. +> [!] Achten Sie darauf, dass Composer für die Installation die selbe PHP-Version verwendet, in der auch Ihr Shop ausgeführt wird. Sie erhalten sonst möglicherweise unpassende Modulpakete. > [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require). \ No newline at end of file diff --git a/docs/daux/installation/030_Update/040_Modulinformationen_aktualisieren.md b/docs/daux/installation/030_Update/040_Modulinformationen_aktualisieren.md index 5e27899..157e8fa 100644 --- a/docs/daux/installation/030_Update/040_Modulinformationen_aktualisieren.md +++ b/docs/daux/installation/030_Update/040_Modulinformationen_aktualisieren.md @@ -2,4 +2,18 @@ title: Modulinformationen aktualisieren --- -Wechseln Sie im Adminbereich zu [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ]. \ No newline at end of file +### **im Adminbereich** + +Wechseln Sie im Adminbereich zu [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ]. + +### **oder auf der Kommandozeile** + +Alternativ können Sie die Modulaktivierung auch über die Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) durchführen. + +```bash +./vendor/bin/oe-console oe:module:activate {$metadataident} +``` + +> [!] **Enterprise Edition**: Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen. + +> [i] **Enterprise Edition**: Zur Aktivierung in einem bestimmten Shopmandanten verwenden Sie das `--shop-id`-Argument (`...oe-console --shop-id 1 oe:module...`) \ No newline at end of file diff --git a/docs/daux/installation/030_Update/050_Shopanpassungen_installieren.md b/docs/daux/installation/030_Update/050_Shopanpassungen_installieren.md index 577efa4..15880bb 100644 --- a/docs/daux/installation/030_Update/050_Shopanpassungen_installieren.md +++ b/docs/daux/installation/030_Update/050_Shopanpassungen_installieren.md @@ -2,10 +2,20 @@ title: Shopanpassungen installieren --- +### **im Adminbereich** + Ob Shopanpassungen notwendig sind, ist von der Versionsänderung des Moduls abhängig. Möglicherweise sehen Sie nach dem Neuaktivieren des Moduls den Installationsassistent, der Sie durch die Änderungen führt. Folgen Sie dann den einzelnen Schritten. Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen. Wird der Assistent nicht gezeigt (Sie sehen wieder die Modulübersicht), waren keine Anpassungen am Shop notwendig. -Ob erforderliche Updates ausgeführt werden sollen, können Sie jederzeit im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ] prüfen. \ No newline at end of file +Ob erforderliche Updates ausgeführt werden sollen, können Sie jederzeit im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ] prüfen. + +### **oder auf der Kommandozeile** + +Der Installationsassistent steht Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3modules_install +``` \ No newline at end of file diff --git a/docs/daux/installation/030_Update/060_TMP-Ordner_leeren.md b/docs/daux/installation/030_Update/060_TMP-Ordner_leeren.md index fb6a3a2..d845b9b 100644 --- a/docs/daux/installation/030_Update/060_TMP-Ordner_leeren.md +++ b/docs/daux/installation/030_Update/060_TMP-Ordner_leeren.md @@ -2,8 +2,20 @@ title: TMP-Ordner leeren --- +### **im Adminbereich** + Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ]. Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch. -> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. \ No newline at end of file +### **oder auf der Kommandozeile** + +Alle TMP-leeren-Aktionen stehen Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3cleartmp +``` + +> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. + +> [i] Beim Kommandozeilenaufruf werden Ihnen weitere Optionen gezeigt, mit denen Sie die Aktion gezielt steuern können. \ No newline at end of file diff --git a/docs/daux/installation/060_Deinstallation/020_Modul_deaktivieren.md b/docs/daux/installation/060_Deinstallation/020_Modul_deaktivieren.md index 067dc42..4ba4d78 100644 --- a/docs/daux/installation/060_Deinstallation/020_Modul_deaktivieren.md +++ b/docs/daux/installation/060_Deinstallation/020_Modul_deaktivieren.md @@ -2,5 +2,18 @@ title: Modul deaktivieren --- -Deaktivieren Sie das Modul **{$modulename}** über den Shopadmin [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ]. +### **im Adminbereich** +Deaktivieren Sie das Modul unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ]. + +### **oder auf der Kommandozeile** + +Alternativ können Sie die Moduldeaktivierung auch über die Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) durchführen. + +```bash +./vendor/bin/oe-console oe:module:deactivate {$metadataident} +``` + +> [!] **Enterprise Edition**: Achten Sie darauf, dass das Modul in allen weiteren Shops (Mall) ebenfalls deaktiviert werden muss. + +> [i] **Enterprise Edition**: Zur Deaktivierung in einem bestimmten Shopmandanten verwenden Sie das `--shop-id`-Argument (`...oe-console --shop-id 1 oe:module...`) \ No newline at end of file diff --git a/docs/daux/installation/060_Deinstallation/030_Modul_aus_der_Installation_entfernen.md b/docs/daux/installation/060_Deinstallation/030_Modul_aus_der_Installation_entfernen.md index 344eb78..02b3ebe 100644 --- a/docs/daux/installation/060_Deinstallation/030_Modul_aus_der_Installation_entfernen.md +++ b/docs/daux/installation/060_Deinstallation/030_Modul_aus_der_Installation_entfernen.md @@ -2,12 +2,12 @@ title: Modul aus der Installation entfernen --- +### **auf der Kommandozeile** + Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Führen Sie Sie dort diesen Befehl aus: ```Bash php composer remove {$composerident} --no-update ``` -> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete. - -> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require). +> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#remove). \ No newline at end of file diff --git a/docs/daux/installation/060_Deinstallation/040_Dateien_loeschen.md b/docs/daux/installation/060_Deinstallation/040_Dateien_loeschen.md index 90c945d..5ce0b87 100644 --- a/docs/daux/installation/060_Deinstallation/040_Dateien_loeschen.md +++ b/docs/daux/installation/060_Deinstallation/040_Dateien_loeschen.md @@ -5,5 +5,5 @@ title: Dateien löschen Löschen Sie den Ordner `{$modulefolder}` und seine enthaltenen Elemente aus dem Verzeichnis `source/modules/d3` Ihres Shops. Bestätigen Sie anschließend im Shopadmin unter [ Erweiterungen ] -> [ Module ] -> [ Installierte Shop-Module ] die Nachricht: -> Es gibt registrierte Erweiterungen im eShop, deren Verzeichnis nicht vorhanden ist. +> Es gibt registrierte Erweiterungen im eShop, deren Verzeichnis nicht vorhanden ist. > Möchten Sie alle Modulinformationen einschließlich Konfigurationseinstellungen und Blockinformationen für Templates löschen? diff --git a/docs/daux/installation/060_Deinstallation/060_TMP-Ordner_leeren.md b/docs/daux/installation/060_Deinstallation/060_TMP-Ordner_leeren.md index fb6a3a2..d845b9b 100644 --- a/docs/daux/installation/060_Deinstallation/060_TMP-Ordner_leeren.md +++ b/docs/daux/installation/060_Deinstallation/060_TMP-Ordner_leeren.md @@ -2,8 +2,20 @@ title: TMP-Ordner leeren --- +### **im Adminbereich** + Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ]. Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch. -> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. \ No newline at end of file +### **oder auf der Kommandozeile** + +Alle TMP-leeren-Aktionen stehen Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3cleartmp +``` + +> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. + +> [i] Beim Kommandozeilenaufruf werden Ihnen weitere Optionen gezeigt, mit denen Sie die Aktion gezielt steuern können. \ No newline at end of file